更新时间:2022-05-07 GMT+08:00
分享

注释

本章节介绍脚本注释的原则和写法。

总体原则

  • 无用的代码不能以注释形式存在。
  • 能用代码说明的尽量不要添加注释,脚本注释尽可能简洁。
  • 建议注释统一用英文。
  • 出入参不必写注释说明。

注释方式

  • 在函数方法和结构体的元数据描述上面添加注释。
    /**
    * 根据产品ID查询产品详情信息
    */
    @action.method({ input: "Input", output: "Output", label: 'queryProductDetailForCart' })
  • 方法内关键业务语句前必须添加注释。
    • 方法内的单行注释以“//”开头,应放在相关代码的上方或右方,不可放于下方;若放于上方,注释需与前面的代码间用空行隔开。
    • 注释与代码的比例没有量化标准;在删掉所有的代码内容、仅保留代码层级结构和注释,如果通过注释,可以很容易理解方法内都做了哪些事情(类似于伪代码),则认为注释比例合理。
    // 校验密码是否正确
    let password = input.password;
    if (accountRecord["Password"] != password) {
    error.name = "CM-001003";
    error.message = "Invalid loginId or password.";
    throw error;
    }
分享:

    相关文档

    相关产品

close