1.@exports 标注class导出到了哪一个大模块上
/**
* @exports map3d.utils.NavigationToolUtil
* @class
* @classdesc 三维导航控件帮助类。
*/
let NavigationToolUtil = { }
export default NavigationToolUtil
2.类的方法注释以及代码格式
1.类的方法注释示例:先@method 方法作用,在@param 方法参数,最后@return 返回值
/**
* 平移模型
* @method
* @param {Cesium.Cartographic} center 模型原地理中心点
* @param {Cesium.Cartographic} target 模型地理中心目标点
* @param {Cesium.Matrix4} [result] 平移矩阵结果
* @returns {Cesium.Matrix4} 平移矩阵
*/
Model3DUtil.fromTranslation = function (center, target, result) { }
2.类的option下有属性 @property {数据类型} option.属性,如果有默认值,
把参数用中括号[option.property=默认值] 表示
/**
* 动态扩散点效果,同上,区别:坐标系转换
* @param {ZViewer} viewer ZViewer对象
* @param {Object} options 参数选项
* @property {Object} options.center 中心点 eg:{lng:110,lat:28,height:0}
* @property {Number} [options.radius=10] 圆半径(米)
* @property {Number} [options.duration=3000] 持续时间间隔(毫秒)
* @property {Cesium.Color} [options.color=Cesium.Color.RED] 颜色
* @property {Number} [options.from=CoordTypeEnum.wgs84] 中心点源坐标系
* @property {Number} [options.to=CoordTypeEnum.wgs84] 中心点目标坐标系
*/
ellipsoidFade: function (viewer, options) { }
3.类中一般会换行的地方:1》let 声明
2》if语句之前,单个if(){}之后
3》return之前 看情况可加可不加
4》类的函数注释之前
@method 方法
@param 参数
@property 参数的属性
@property {Number} [option.property=默认值] 注释解释
@returns 返回值
@static 类本身调用的方法
@private 私有变量
3.对象枚举注释示例
let GEOJSON_TYPE = {
/**
* GeoJSON的点类型
*/
POINT: 'Point',
/**
* GeoJSON的线串类型
*/
LINE_STRING: 'LineString',
/**
* GeoJSON的线环类型
*/
LINEAR_RING: 'LinearRing',
/**
* GeoJSON的多边形类型
*/
POLYGON: 'Polygon',
}