前言
在工作中,团队开发,为了代码的维护性,常要求写注释,现分享一些常用注释标签
注释用法
以vscode为例:
输入:/** 然后回车就可以自动生成一个注释代码块了,然后在注释块里面输入@标签:描述
常用标签总结
@author:作者
@class:类
@callback:回调
@constructor:类的回调函数
@classdesc:类描述
@const:常量
@default:默认值
@desc:描述
@example:举例
@name:名称:用于抽象方法或匿名函数
@param:参数
@arg:参数
@argument:参数
@property|@prop:属性
@requires:依赖
@return 返回
@type 类型
使用
这个类我增加了这些注释,一个方便阅读理解。另外一个:
你在引用的时候它就会把注释直接调取出来了