APPCUBE-Widget开发规范:函数/方法注释

时间：2023-11-01 16:15:17

APPCUBE 前端开发规范

函数/方法注释

函数/方法注释采用典型的JSDoc的注释方式。

函数注释入参说明：@param + 1个空格+ {参数类型} + 1个空格 + 参数名+ 1个空格 + 参数说明。
函数注释出参说明：@return + 1个空格 + {参数类型} + 1个空格 + 出参说明（若没有出参，则出参说明可不写）。

有关键逻辑或者重大变更时，增加改动者及改动描述。

        /**          * 在地图上创建标志          *          * @param {String} latLng 经纬度信息          * @param {Object} mapInfo 地图描点信息          * @return {Boolean} 在地图上创建点选标志的结果         * @version 20180310  modify by xxx shangsan 修改地图上描点的样式         * @version 20180314  modify by xxx wangwu 在地图上描点增加事件发送，供外部订阅         */         var placeMarkerAndPanTo=function(latLng, mapInfo) {                                      //返回创建点选标志的结果              return true;           }

上一篇：APPCUBE-Widget开发规范:桥接器Bridge

下一篇：APPCUBE-Widget开发规范:桥接器Bridge