可信智能计算服务 TICS-注释规范

时间:2023-11-05 10:55:03

注释规范

注释是用来告诉读者程序编写的目的及其主要工作原理。目前支持两种注释方式:单行注释“--”,多行注释“/**/”。

建议:

  • 源程序有效注释量必须在30%以上。
  • 注释的内容要清楚、明了,含义准确,防止注释二义性。
  • 禁止在注释中使用缩写。
  • 除文件头的注释外,程序内部统一使用"--"进行注释。
  • 统一文件头的注释,建议采用多行注释方式。
  • 所有表字段定义,统一在后面添加注释,说明该字段的用途和含义。
  • 注释与相应的代码具有同样的缩进。
  • 注释与其上面的代码应用空行隔开。
  • 复杂的SQL语句,必须有注释对其功能和逻辑进行说明,满足下述条件之一即为复杂SQL:
    • 连接的表大于2个。
    • 嵌套的层次大于3层。
    • 同时含有GROUP BY和ORDER BY。
support.huaweicloud.com/usermanual-tics/tics_rtd_01_0024.html