blocks|key|942832|text|第一个示例中的注释样式不仅仅是一种约定，它还是一个名为Javadoc的文档工具的标准。如果您遵循Javadoc注释样式，您将能够轻松地为所有源代码生成html格式的文档。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|942833|entityMap|0|LINK|mutability|MUTABLE|url|http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html^0|R|7|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

The comment style in your first example is not just a convention, it is a standard for a documentation tool called <a href="http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html" rel="nofollow noreferrer">Javadoc</a>. If you follow that Javadoc commenting style, you will be able to easily generate html formatted documentation for all of your source code.

blocks|key|942892|text|我会简单地遵循Sun+(Oracle)定义的编写Javadoc的标准。Javadoc被所有开发人员一致引用:)。有关详细信息，请单击here|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|942893|我也会请你在search+on+Stackoverflow上做很多问题和评论的答案。|942894|https://stackoverflow.com/search?q=commenting|942895|entityMap|0|LINK|mutability|MUTABLE|url|http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html|1|2^0|1U|4|0|0|6|N|1|0|0|19|2|0^^$0|@$1|2|3|4|5|6|7|R|8|@]|9|@$A|S|B|T|1|U]]|C|$]]|$1|D|3|E|5|6|7|V|8|@]|9|@$A|W|B|X|1|Y]]|C|$]]|$1|F|3|G|5|6|7|Z|8|@]|9|@$A|10|B|11|1|12]]|C|$]]|$1|H|3|-4|5|6|7|13|8|@]|9|@]|C|$]]]|I|$J|$5|K|L|M|C|$N|O]]|P|$5|K|L|M|C|$N|G]]|Q|$5|K|L|M|C|$N|G]]]]

I would simply follow standard defined by Sun (Oracle) for writing Javadoc. Javadoc is referred by all developers unanimously :). For more information click <a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html" rel="nofollow noreferrer">here</a>

I would also ask you to do following <a href="https://stackoverflow.com/search?q=commenting">search on Stackoverflow</a> for lots of questions and ansers on commenting.

<a href="https://stackoverflow.com/search?q=commenting">https://stackoverflow.com/search?q=commenting</a>

blocks|key|1157076|text|This链接非常有用，我已经使用它很长一段时间了，对我帮助很大。这将创建一个非常好的、有文档记录的代码，具有最大的可靠性。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1157077|entityMap|0|LINK|mutability|MUTABLE|url|http://www.oracle.com/technetwork/java/codeconventions-150003.pdf^0|0|4|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

<a href="http://www.oracle.com/technetwork/java/codeconventions-150003.pdf" rel="nofollow">This</a> link is very useful and i have been using this for a long time and has helped me a lot. This creates a very good and documented code with maximum readiblity.

blocks|key|1157135|text|首先，拥有可读的代码和可读的注释是两件完全不同的事情。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1157136|可读代码是使用良好的变量、方法、类名等的代码。|1157137|可读的评论更多的是个人品味的问题。有些人喜欢评论遵循语法规则，用来写一本书，而另一些人则不关心语法方面的东西。您可以通过此链接访问：|1157138|http://www.oracle.com/technetwork/java/codeconventions-141999.html#385|offset|length|1157139|通过可读的代码和注释，您可以在doxygen的帮助下创建文档。|1157140|http://www.doxygen.nl/manual/docblocks.html|1157141|entityMap|0|LINK|mutability|MUTABLE|url|1^0|0|0|0|0|1Y|0|0|0|0|17|1|0^^$0|@$1|2|3|4|5|6|7|V|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|W|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|X|8|@]|9|@]|A|$]]|$1|F|3|G|5|6|7|Y|8|@]|9|@$H|Z|I|10|1|11]]|A|$]]|$1|J|3|K|5|6|7|12|8|@]|9|@]|A|$]]|$1|L|3|M|5|6|7|13|8|@]|9|@$H|14|I|15|1|16]]|A|$]]|$1|N|3|-4|5|6|7|17|8|@]|9|@]|A|$]]]|O|$P|$5|Q|R|S|A|$T|G]]|U|$5|Q|R|S|A|$T|M]]]]

First off all having readable code and readable comments are two things that are totally different. 

Readable code is code the uses good variable, method, class names, etc.

Readable comments are more a matter of personal taste. Some people like comments to follow grammatical rules that would be used to write a book while others couldn't care less about grammatical stuff. You can go through this link:

<a href="http://www.oracle.com/technetwork/java/codeconventions-141999.html#385" rel="nofollow noreferrer">http://www.oracle.com/technetwork/java/codeconventions-141999.html#385</a>

From readable code and comments, you can create documentation with the help of doxygen.

<a href="http://www.doxygen.nl/manual/docblocks.html" rel="nofollow noreferrer">http://www.doxygen.nl/manual/docblocks.html</a>

Which method of commenting is most widely accepted or does it really matter?

I have been using 

<pre><code>/** 
 * (Method description)
 * @param
 * @return
 * etc
 */
</code></pre>

However I have read of:

<pre><code>Precondition:
Postcondition:
</code></pre>

Is there a more 'professional' way of commenting?

Java Commenting Conventions

哪种评论方法最被广泛接受，或者它真的很重要吗？我一直在用/**   * (Method description) * @param * @return * etc */然而，我读到过：Precondition:Postcondition:有没有更“专业”的评论方式？

问Java注释约定
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Java注释约定EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Java注释约定
EN