「代码自注释」是不是一个程序员为了不写文档的借口
如果能确保代码自注释...包括但不限于:1,变量名能说明其意义,函数名能说明其意义2,嵌套较少3,代码后期的维护没有产生歧义4,函数调用之间...类之间...关系自然.......等等那是可以不写注释...但是能做到的代码有几个?
■网友
文档是什么？注释和文档有什么关系？代码是一类文档，代码中的注释也可以算一种类型的文档，不包含在代码中的信息写在哪里？当然要写在其他文档里，一图胜千言，你打算在wiki上贴张图还是打算在代码注释里写上没时间看懂的两千字，大家都很忙，给我直接读懂结构的图。所以，要看你题目中的“文档”是怎么要求的啊，自注释的代码是很好的，但是还是会有些使用代码注释描述不清的知识，是需要其他文档补充的。但不要太限制这类文档的格式，能把问题说清楚，我便认为是好的。------------------------------------附上我对文档的一点见解：文档记录要尽可能让更多人访问
文档记录要尽可能让更多人更方便地访问
文档记录之间要能系统性结构性的建立联系
文档记录要主动提过而不要等待别人问询
文档记录的更改历史也要可追踪
文档记录更新要及时
。。。
【「代码自注释」是不是一个程序员为了不写文档的借口】 能满足这些要求的文档形式真不多
■网友
这口号本身是没错的，但从现实的角度来看，对大部分的程序员来说，是的，确实是借口。但解决方案并不是加上注释，而是把代码写的漂亮，写的干净。在屎上放鱼子酱，不会让人对屎产生食欲。
推荐阅读
- 银行系统的研发岗(程序员)是不是很难进(校招)推广到国企的研发岗(程序员)呢
- 鬼斗车|安全性是不是韩系车短板？到车里去寻找下答案！
- 孩子|张奶奶笔记：母乳是不是吃饱了？(权威文献摘录）
- Syniverse是不是南京最难进的IT公司
- 怎样对别人的代码进行适当修改使他永远也找不到问题出在哪
- 如果把DNS从godaddy转到DNSPOD是不是所有的二级域名都要重新设置，然后等这个各个ISP的缓存重新解析啊
- 看看老板是不是在画饼
- 当有人形容你翻脸比翻书还快，咋回答
- 优酷的立体声功能是不是脑残设计
- 妙招|有需要的快收藏吧你家宝宝是不是已经开始流口水了？护理有妙招