全球主机交流论坛

标题: 全球编程论坛，代码注释狂魔怎么写比较合适？ [打印本页]

作者: senwzz 时间: 2020-7-2 10:33
标题: 全球编程论坛，代码注释狂魔怎么写比较合适？
// 说明 if else 的注释
if (....) {
// 说明以下判断块的注释
// 说明第一句代码的注释（这里该怎么让块和第一句的注释有所区别，这样不是在一起了）
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
} else {
// 说明以下内容块的注释
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
}

作者: 夕日 时间: 2020-7-2 10:36
写这么多注释还不如把变量名起得有意义一点

作者: yrj 时间: 2020-7-2 10:39
没必要过度注释

作者: ZjuSa.pRo 时间: 2020-7-2 10:40
空一行啊，或者直接注释在第一句后面

作者: heihai 时间: 2020-7-2 10:41
虽然说清晰的注释很重要，但也没必要像这样搞吧

作者: allnetstore 时间: 2020-7-2 10:43
你需要的不是注释，是中文编程

作者: 大杀器 时间: 2020-7-2 10:43
你这也太多了，一般我就这么干

if (....) { // XX判断开始条件：xxx
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
} else { //条件外执行XX操作
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
....巴拉巴拉
} // XX判断结束

复制代码

作者: llyang 时间: 2020-7-2 10:44
介个。。。。
'
#
rem
....
语言不一样，注释完全不同

作者: Jay 时间: 2020-7-2 10:45
注释多了, 严重影响我一目十行代码

作者: senwzz 时间: 2020-7-2 10:45

ZjuSa.pRo 发表于 2020-7-2 10:40
空一行啊，或者直接注释在第一句后面

空一行难看。。强迫症
写代码行尾会不产生很多修改的不方便，很早就放弃了
可能应该弄个[] 描述下会比较好

作者: 十香 时间: 2020-7-2 10:45
'火星文显得独特一点 ,着实有文采也可以配首诗

作者: 未闻听心 时间: 2020-7-2 10:47
正经人谁写注释？？？？？
尽量让一个方法只做一件事，尽量把方法名写清楚，方法名尽量不要简写，不要怕他名字长；
能用变量名，能用方法名说明代码功能的尽量不要写注释；
注释一般用于实在代码表达不清楚的地方。
注释太多等于无。

作者: 未闻听心 时间: 2020-7-2 10:50
仅限于工作中哈； //此处说明上诉表达适用范围
如果大佬要写教程出来，每句话都注释也无妨，一般在后面

作者: senwzz 时间: 2020-7-2 10:51

Jay 发表于 2020-7-2 10:45
注释多了, 严重影响我一目十行代码

注释多，一目一篇

作者: 极限挑战 时间: 2020-7-2 10:52
擦光顾着看你头像去了

作者: senwzz 时间: 2020-7-2 10:53

大杀器发表于 2020-7-2 10:43
你这也太多了，一般我就这么干

如果写尾部只能写一行，多行就不行了

作者: senwzz 时间: 2020-7-2 10:55

heihai 发表于 2020-7-2 10:41
虽然说清晰的注释很重要，但也没必要像这样搞吧

要写啊，一年后自己都看不懂自己当初是怎么个想法，注释为了自己快速回忆进入状态，防止越改越错

作者: 大杀器 时间: 2020-7-2 10:56

senwzz 发表于 2020-7-2 10:53
如果写尾部只能写一行，多行就不行了

大致描述一下就好了，详细看代码啊，自己写的还看不懂嘛。
工作都在注释上了不然

作者: senwzz 时间: 2020-7-2 10:58

极限挑战发表于 2020-7-2 10:52
擦光顾着看你头像去了

色即是空，空即使色

作者: victor_ada 时间: 2020-7-2 11:00
去看阿里的代码规范

作者: leven5 时间: 2020-7-2 11:12
变量名别太**就行了...

作者: 野兔 时间: 2020-7-2 11:18
最烦两件事：1.别人的代码不写注释；2.写注释。

作者: senwzz 时间: 2020-7-2 16:25

野兔发表于 2020-7-2 11:18
最烦两件事：1.别人的代码不写注释；2.写注释。

比起写文档说明还是好多了。。。

作者: wqz 时间: 2020-7-2 16:33
注释写的比代码多

之前写过一个python程序程序段82行注释97行
这种把注释写成半个开发文档的情况利于后续开发以及他人接手

作者: chinayang 时间: 2020-7-2 16:42
别用拼音的首字母组成变量名就好，这玩意一般人还真看不懂，哪怕全拼都行

欢迎光临全球主机交流论坛 (https://loc.010206.xyz/)