sublime-ngdoc-snippets

只是创建 Angular/ngdoc 相关文档的一些小插件集合。

您应该与 DocBlockr 结合使用，以获得良好的工作流程。让 DocBlockr 通过 /** 按 TAB 键创建文档，然后添加您的 ngdoc 插件。

查看 angular 官方维基百科上的关于编写 Angular 相关文档的说明： 编写 AngularJS 文档。

插件

• $ngd+ 添加 @ngdoc 注释的完整文档堆栈

  $ngdoc {...}  
  
  @name {name}  
  
  @deprecated
  @scope
  @eventType emit|broadcast
  @link
  @requires {service}  
  @propertyOf {method}  
  @methodOf {method}  
  @function  
  @element
  @elementOf {type}
  @description
  @param {type}
  @returns {type}
  

• $dep 添加 @deprecated

• $des 添加 @description

• $ele 添加 @element

• $eof 添加 @elementOf {类型}

• $eve 添加 @eventType emit|broadcast

• $fun 添加 @function

• $lin 添加 @link

• $met 添加 @methodOf {方法}

• $nam 添加 @name {名称}

• $ngd 添加 @ngdoc

• $par 添加 @param {类型}

• $pri 添加 @private

• $pro 添加 @propertyOf {方法}

• $req 添加 @requires {服务}

• $ret 添加 @returns {类型}

• $sco 添加 @scope

• $thi 添加 @this