评论代码

时间:2011-01-14 21:45:12

标签: java comments coding-style

是评论代码的最专业和信息丰富的方式。那里有标准吗?

P.S。它不一定是javadoc,只是包含什么的信息 - 任何常见的布局等

欢呼人们

6 个答案:

答案 0 :(得分:2)

答案 1 :(得分:1)

答案 2 :(得分:1)

我认为这取决于,javadocs适合大型项目。如果它是一个小项目或学校作业的东西,在方法标题之前的一个小描述将很好地做,并且可能在方法中有一些散布的注释,以防你以非正统的方式做事。在这些之前我会建议你给你的方法提供信息名称以及变量和参数,这样就可以更容易地推断出方法的作用,而不是阅读并试图弄清楚每个参数的确切含义等等。 / p>

答案 3 :(得分:1)

Steve McConnel的书 代码完成 - 毫无疑问是关于如何编写软件的最好的书 - 有一整章关于如何编写注释以及确保您的代码被理解 - 称为“自我记录代码”。

答案 4 :(得分:0)

答案 5 :(得分:0)