哪种评论方法被广泛接受或者真的重要?
我一直在用
/**
* (Method description)
* @param
* @return
* etc
*/
Run Code Online (Sandbox Code Playgroud)
不过我读过:
Precondition:
Postcondition:
Run Code Online (Sandbox Code Playgroud)
是否有更"专业"的评论方式?
我与之合作的开发人员有一些关于我感兴趣的评论的话题(见下文).您的个人做法/评论意见是什么?
"我不会在代码中添加注释,除非它是一个简单的标题,或者存在
平台错误或必要的解决方案,这是不明显的.代码可能会改变,注释可能会产生误导.代码应该
在使用时自我记录描述性的名称和其逻辑
的组织-和其解决方案应该是干净的/最简单的方法
,完成既定任务如果程序员不知道程序是什么
呢只阅读代码,那么他不准备改变它.
评论往往是写一些复杂
或非显而易见的东西- 我的目标是始终编写简洁明了的代码.""我认为在评论方面存在一些阵营,那些认为他们正在编写API的企业级人员和一些将在未来几代使用的宏大代码库,这位工匠般的程序员认为代码说的是什么它比评论更清晰,并且新手编写详细/不清楚的代码,以便需要给自己留下笔记,告诉他们为什么要做某事."