如何写好代码注解——走过路过不要错过

赵国辉 · 发表于 2010-1-9 21:13

抛下一个题目，大家有时间可以探讨一下
【如何写好代码注解】

lb_bn · 发表于 2010-1-9 21:14

不怎么会写注解。

赵国辉 · 发表于 2010-1-9 21:19

忘记在哪里看到的：当你的注解量是代码的10倍，在某种程度上，你才是个合格的程序员（不是原话，自己理解的）
大家的代码注解习惯是什么呢？
1、注解的位置？（相对代码——上、下、右？）
2、注解的内容（主要注解哪方面？语法还是代码执行的目的）
3、注解的美化（如何让注解看起来更动人？）

赵国辉 · 发表于 2010-1-9 21:21

'************以下代码循环去除多余空格导致的无效数据***********
For i = 0 To n
If Len(strTemp(i)) Then
strArr(m) = strTemp(i)
m = m + 1
End If
Next

复制代码

这是我一直的习惯

赵国辉 · 发表于 2010-1-9 21:22

'<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
'>>>>>>>>>>>>>>>调用RecordToArray过程<<<<<<<<<<<<<<<<<<<
'<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

看到南宫兄的代码，这个好像是他的习惯

amolin · 发表于 2010-1-9 21:32

注解写的多，不一定是好的程序员，提高代码的自解释性才是最重要的。

lb_bn · 发表于 2010-1-9 22:09

写文档。。。。。。。

赵国辉 · 发表于 2010-1-9 22:13

原帖由 amolin 于 2010-1-9 21:32 发表
注解写的多，不一定是好的程序员，提高代码的自解释性才是最重要的。

请兄台多说两句哈

灰袍法师 · 发表于 2010-1-9 23:11

原帖由 amolin 于 2010-1-9 21:32 发表
注解写的多，不一定是好的程序员，提高代码的自解释性才是最重要的。

握手，让人一看就懂的代码比一千行注释更有效。

一般来说，比代码注释更重要的事情是：
给变量和函数起个一看就懂的好名字（这个最难，貌似很多人一辈子就只用Value，Data，Number，Count，temp这些单词，更恶劣的是a1,l2,t3这样的火星文）
尽量把程序分割为较少代码的子程序，最低限度也要输入，处理，输出是分开处理，不要写在一块。
不要用三重或者更多的循环。
不要用多重IF语句，或者一个IF里面带有很复杂的逻辑判断。

如果你的代码需要注释才能让人看懂，那么最好还是重新组织代码。

wuyouyidish · 发表于 2010-1-9 23:17

每行代码后写上注释对于初学者看懂代码、运用、调用.........我觉得很有帮助

		自动登录	找回密码
密码			免费注册

[讨论] 如何写好代码注解——走过路过不要错过

回复 4楼赵国辉的帖子

[讨论] 如何写好代码注解——走过路过不要错过

回复 4楼 赵国辉 的帖子

回复 4楼赵国辉的帖子