pen*_*ake 3 .net c c# java comments
想象一下......你写了一些代码; 实现了一些接口,使用了一些设计模式,通过了许多单元测试,为了重构提取了许多方法等等.你开发,开发,开发......但是在某些神秘的地方,出于某种原因你,你内心的某些东西开始低声说你现在应该写评论.有些东西嘲笑你,如果你不写评论,某些东西会丢失,或者某些东西可能不完全清楚......
然后你评论你的代码!:(
这可能是一个糟糕设计的秘密标志吗?
如果你发现自己处于一种情况,即如果你没有在那个精神(!)时刻评论你的代码,它就不会完成任务 ; 我们可以将其视为代码中可能的错误设计的可靠症状吗?
如果你觉得你应该添加评论,因为缺少某些东西(客户的文档可能!),那么它可能并不表示你的代码本身是坏的.如果你因为某些事情不清楚而添加评论,你需要决定是否不清楚,因为代码很难或因为底层域很难.如果是代码,则需要重写它以使其更清晰.如果它是使其变得困难的域名,请随意对那些不熟悉相关域名的人进行广泛评论,并保留代码.
| 归档时间: |
|
| 查看次数: |
174 次 |
| 最近记录: |