如何使计划评论更有用?

ACP*_*ACP 2 comments

海家伙,

我看到人们在他们的节目中包括评论..

  • 它是通过明确指定程序员的意图和假设来改进程序员之间的通信和代码可读性吗?

  • 评论应该是技术术语而不是自然语言吗?

  • 如何使用评论尽可能有效?

  • 在程序中添加注释真的是一个很好的做法吗?

Bry*_*ley 7

注释只应用于解释代码为何如此.它不应该解释什么代码正在做什么.代码描述了代码正在做什么.

话虽这么说,一些语言有工具,在评论中寻找特殊字符,以生成文档.Java就是这样一种语言.但这些并不是代码注释,因为它们恰好使用与语言注释相同的语法.

  • 或者应该由代码描述...注释不能替代可读代码. (2认同)