代码注释

注释

注释的目的

提高代码的可读性，从而提高代码的可维护性

注释的原则

如无必要，勿增注释 ( As short as possible )
如有必要，尽量详尽 ( As long as necessary )

描述

/**
 * @description 模块
 * @author CJ
 * @date 2020-20-20 16:16:52
 * @lastModifiedBy 最新的变更人	
 * @lastModifiedTime 最新的更新时间
 */

应用

init: function() {
  // 获取配置信息
  const config = getConfig();
  // 获取用户信息
  const userInfo = getUserInfo();
  // 根据配置和用户信息，进行初始化
  doInit(config, userInfo);
  // 如果存在自定义配置时的特殊逻辑
  if (config.custom) {...}
}