欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  数据库

【数据库编程标准规范系列】之第八章:代码的注释

程序员文章站 2022-06-08 07:53:16
...

不编写注释的理由: 费时间 很难写注释(客户更难读懂=烂代码) 8.1 编程原则 8.1.1 出色的注释,给代码增加信息量 8.1.3注释,捕获代码中的错误,为什么要捕获?什么错误?错误分类的阐述? 8.1.4 在编写代码前,进行注释 编写完整句子的注释或伪代码,注释

不编写注释的理由:

费时间

很难写注释(客户更难读懂=烂代码)

8.1 编程原则

8.1.1 出色的注释,给代码增加信息量

8.1.3注释,捕获代码中的错误,为什么要捕获?什么错误?错误分类的阐述?

8.1.4 在编写代码前,进行注释

编写完整句子的注释或伪代码,注释之间编写代码

8.1.5 纯色字符注释行

8.1.8注释可读性,供人阅读(难以理解的注释=根本没有注释)

注释属于文字信息

实际应用举例

使用完整的语句(最好不要分成段落)

避免使用缩写

将整个单词大写,突出重要性

8.1.9 注释缩进,与代码语句对齐

8.1.10每过程都应该有一个注释标头,格式化

8. 1.11 内部注释,说明代码进程

(1)每个If语句前加注释

(2)每个Select Case语句前加注释

(3)每个循环(For. . . Next和Do循环)前加注释

(4)在修改了全局变量的每个语句前面加上注释,便于调试

8.1.12行尾注释,较短描述;内部注释,较长描述