代码注释的魅力所在
标准函数式注释
/** * @method 方法名 * @for 所属类名 * @param{参数类型}参数名 参数说明 * @return {返回值类型} 返回值说明 */
文件头部注释
/** * @Description: In User Settings Edit * @Author: your name * @Date: 2019-06-05 16:09:00 * @LastEditTime: 2019-06-05 16:09:00 * @LastEditors: your name */
常用
// TODO: 待完善 // FIXME: 待优化 /** * @class * @callback * @param * @argument * @constructs * @return * @returns * @author * @see * @version * @requires * @throws * @exception * @link * @author * @class * @constructor * @type * @extends * @example * @private * @final * @event * @global * @default * @module * @todo * @fixme */
参考链接