这个注释中的1,2,3,4需不需要去掉，感觉有的话好像比较详细，但是是不是不规范或不好

long7qazzaq

这个注释中的1,2,3,4需不需要去掉，感觉有的话好像比较详细，但是是不是不规范或不好 [复制链接]

 

这个注释中的1,2,3,4需不需要去掉，感觉有的话好像比较详细，但是是不是公司中都不这么写或者不规范，想请教下

chunyang

这个跟个人习惯有关，如果公司有统一要求则按统一要求办，没有统一要求也无所谓，但最好说明给出数字标号的原因解释，避免他人产生误解。

lcofjp

注释不要太详细，显得很罗嗦，看你的命名已经很好，大部分可以不言自明。

数字，正常情况没啥必要，程序清晰的话，没有数字也是一目了然。

long7qazzaq

chunyang 发表于 2020-5-29 16:35 这个跟个人习惯有关，如果公司有统一要求则按统一要求办，没有统一要求也无所谓，但最好说明给出数字标号的 ...

谢谢前辈的回答和帮助，想问下，在公司里这么写，会不会要求重写，或者这样有什么坏处吗，因为看到很少有人这么写

long7qazzaq

lcofjp 发表于 2020-5-29 18:56 注释不要太详细，显得很罗嗦，看你的命名已经很好，大部分可以不言自明。 数字，正常情况没啥必要，程序 ...

谢谢前辈的回答和帮助，想问下，在公司里这么写，会不会要求重写，或者这样有什么坏处吗，因为看到很少有人这么写，或者前辈身边有这么写的吗

freebsder

改变量名和函数名。比如S表示的意思是距离，用range或distance，400，500这种用UPPER_DISTANCE 或者 LOWER_DISTANCR表示，函数比如clockwise_rotation，可以消除大部分注释。

chunyang

long7qazzaq 发表于 2020-5-29 23:45 谢谢前辈的回答和帮助，想问下，在公司里这么写，会不会要求重写，或者这样有什么坏处吗，因为看到很少有 ...

这个建议你去了解一下所在公司的有关规定，不同企业在这方面的要求差别极大，一切得按企业的要求进行。

long7qazzaq

chunyang 发表于 2020-5-30 17:36 这个建议你去了解一下所在公司的有关规定，不同企业在这方面的要求差别极大，一切得按企业的要求进行。

主要是我还没这方面工作，所以也不知道究竟是怎样的的？

long7qazzaq

freebsder 发表于 2020-5-30 17:35 改变量名和函数名。比如S表示的意思是距离，用range或distance，400，500这种用UPPER_DISTANCE 或者 LOWER_ ...

我是想问注释中的1,2,3,4,5这些是不是不规范，现实工作中是不是不可以这样

freebsder

long7qazzaq 发表于 2020-5-30 17:48
我是想问注释中的1,2,3,4,5这些是不是不规范，现实工作中是不是不可以这样

有文档配合就是合理的。文档中给出1，2，3，4等步骤或状态，代码里标明这几行是哪个步骤，另外几行是哪个步骤。也可以在函数头的注释里统一处理成参见某文档第几节说明。
规范是规范，规范规定的是行为，具体写啥内容根据实际情况，原则是其他人能明白注释表达的东西，不啰嗦不重复不流于形式即可。

long7qazzaq

freebsder 发表于 2020-5-30 20:15 有文档配合就是合理的。文档中给出1，2，3，4等步骤或状态，代码里标明这几行是哪个步骤，另外几行是哪个 ...

谢谢大神了，主要我有一段时间这么编程，身边也都是自学的朋友，夸我这样清晰明了易懂，我觉得有一定的道理，后来发现很多前辈们基本都没有我这样编写的，我一下子转不过弯来，很困惑，也不知道问谁好，想知道在工作中这样写，会不会不合格直接重写或被辞退什么的，我好提前改掉

long7qazzaq

lcofjp 发表于 2020-5-29 18:56 注释不要太详细，显得很罗嗦，看你的命名已经很好，大部分可以不言自明。 数字，正常情况没啥必要，程序 ...

谢谢大神了，主要我有一段时间这么编程，身边也都是自学的朋友，夸我这样清晰明了易懂，我觉得有一定的道理，后来发现很多前辈们基本都没有我这样编写的，我一下子转不过弯来，很困惑，也不知道问谁好，想知道在工作中这样写，会不会不合格直接重写或被辞退什么的，我好提前改掉

chunyang

long7qazzaq 发表于 2020-5-30 17:47 主要是我还没这方面工作，所以也不知道究竟是怎样的的？

那就不必着急，等工作了以后再说，而养成并坚持详细程序注释的习惯很重要。

chunyang

long7qazzaq 发表于 2020-6-1 11:25 谢谢大神了，主要我有一段时间这么编程，身边也都是自学的朋友，夸我这样清晰明了易懂，我觉得有一定的道 ...

企业有规定，按规定的执行。没规定，只要你的软件运行正确，绝不会有人因你的注释与众不同而开除你。

lcofjp

long7qazzaq 发表于 2020-6-1 11:25 谢谢大神了，主要我有一段时间这么编程，身边也都是自学的朋友，夸我这样清晰明了易懂，我觉得有一定的道 ...

太罗嗦，没必要，大多都是无用功，写代码的指导原则是只给复杂的不容易理解的部分加注释，简洁明了的地方加注释属于画蛇添足，代码反而显得杂乱。开除不至于，看你代码最多的人还是你自己