java风格注释_2.16.1 适当的注释和注释风格

2.16   程序设计风格和文档

编程风格(programming style)决定程序的外观。如果把整个程序写在一行，它也会被正确地编译和运行，但是这样是非常不好的程序设计风格，因为这会使程序的可读性很差。文档(documentation)是嵌在程序中的解释性评注和注释的一个结构体。程序设计风格与文档和编写代码的作用一样重要。良好的程序设计风格和适当的文档可以减少出错的几率，并且提高程序的可读性。到现在为止，已经学习了一些好的编程风格。本节把它们总结出来，并给出几条指导原则。关于Java程序设计风格和文档更详细的指南，可以在本书配套网站上的补充材料I.D中找到。

2.16.1   适当的注释和注释风格

在程序的开头写一个摘要，解释一下这个程序是做什么的、其主要特点以及所用到的独特技术。在较大的程序中还要加上注释，介绍每一个主要步骤并解释每个难以读懂之处。注释写得简明扼要是很重要的，不能让整个程序都充满注释而使程序很难读懂。

除了行注释//和块注释/*之外，Java还支持一种称为Java文档注释(javadoc comment)的特殊注释形式。javadoc注释以/**开始，以*/结尾。它们能被JDK的javadoc命令提取出来，放入一个HTML文件。为了得到更多信息，参见java.sun.com/j2se/javadoc。

使用javadoc注释(/**...*/)来注释整个类或整个方法。为了将这些注释提取出来放在一个javadoc的HTML文件中，这些注释必须放在类或者方法头的前面。要注释方法中的某一步骤，建议使用行注释(//)。

【责任编辑：云霞 TEL：(010)68476606】

点赞 0