编写代码时，注释写还是不写

作者 & 编辑：按键学院   【按键精灵】

小编听过一句很有意思的话：

“程序员最讨厌的四件事：写注释、写文档、别人不写注释、别人不写文档”

豆瓣上有被折腾的大神吐槽：

“憎恨不写注释的人！！下班前准备好麻袋，还要一个榔头，血洗……”

也有同学们反驳：

“好的代码本身就是最好的注释，写一堆注释本身就说明代码有问题。”

其实众说纷纭，各有道理。每件事都有它的正反两面，优胜劣势。

在此，小编发表下自己的观点，观点清晰简洁的注释还是很有必要的。良好的代码习惯，能带来事半功倍的效果。

不管是作为范例给别人参考，还是多年后自己翻出当年的代码，良好的注释都能一目了然。

注释的书写格式                                                    

按键精灵的注释有三种格式：

本帖隐藏的内容

1.单引号:'需要注释的内容

1. Call 自动打怪()  '调用自动打怪子程序

2. /*需要注释的内容*/

1. Call 自动打怪()  /*调用自动打怪子程序*/

3. //需要注释的内容

1. Call 自动打怪()  //调用自动打怪子程序

注释的添加原则                                               

1. 完美注释的第一条原则：形式统一

      简洁明了的注释，全文都用一种固定格式的注释形式，不要一会用//，一会用'。

 

2.完美注释的第二条原则：简洁明了
      能用一个词表达的意思，不要再啰嗦成一大段了T_T。比如“打怪”，就不要说“遇到怪物，判断血条之后……再打”
      多余无用的注释，不要~~~坚决say no
      注释的数量不要太多，不要为了注释而去注释。

3.完美注释的第三条原则：注释先于代码创建（或边写代码边写注释）
      不要太相信自己的记忆力，人脑记忆容量在一段时间内是有限的。你一转身就可能忘记你刚刚脑子里想的事呢。

      人脑的瞬时记忆容量与保持时间：
图像记忆：保持时间0.25-1秒，容量为9-20个bit（项目）
声象记忆：保持时间大约2秒，不长于4秒，容量为5个bit

4.完美注释的第四条原则：注释的位置，就近原则。
      保证注释与其描述的代码相邻，即注释的就近原则。
一般代码注释：放在其上方相邻或右方的位置，不可放在下方。
批量变量声明注释：行尾注释是合适的，在这种情况下，将所有行尾注释要对齐。

5.完美注释的第五条原则：一些添加注释的建议。

-->>典型算法必须有注释。

-->>在代码不明晰或不可移植处必须有注释。

-->>在代码修改处加上修改标识的注释。

-->>在循环和逻辑分支组成的代码中添加注释。

-->>为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队环境中。

 

分享大神美美的代码注释

// 运行程序获取句柄

Event Form1.Button5.Click

    代码内容

End Event

 

// 运行程序获取编辑框句柄

Event Form1.Button8.Click

    代码内容

End Event

 

// 获取控件句柄[枚举]

Event Form1.Button6.Click

1.         hWnd = Plugin.tz.GetEnumWindow(CLng(Form1.InputBox1.Text), CLng(Form1.InputBox2.Text))

2.         MsgBox hWnd

3. End Event

4. 

5. // 获取控件句柄[ID]

6. Event Form1.Button7.Click

7.         hWnd = GetDlgItem(CLng(Form1.InputBox3.Text), CLng(Form1.InputBox4.Text))

8.         MsgBox hWnd

9. End Event

10. 

11. // 前台方式模拟画图

12. Event Form1.Button9.Click

13.     代码内容

14. End Event

15. 

16. // 后台方式模拟画图

17. Event Form1.Button10.Click

18.     代码内容

19. End Event

20. 

21. // 前台方式操作记事本

22. Event Form1.Button11.Click

23.     代码内容

24. End Event

25. 

26. // 后台方式操作记事本

27. Event Form1.Button12.Click

28.     代码内容

29. End Event

复制代码