将注释添加到Java代码中 - 傻瓜

这个Java列表有一个示例程序的增强版本。除了所有的关键字，标识符和标点符号之外，还有一些文字是供人类阅读的。在“Java For Dummies，第6版”中列出了3-6。* *版权所有2014 Wiley Publishing，Inc. *保留所有权利。 * / / ** *显示器类在电脑屏幕上显示文本*。 * * @作者Barry Burd * @version 1. 0 10/24/13 * @see java。郎。系统* /公共类显示器{/ ** *主要方法是开始执行代码的地方。 * *参数args（参见第11章）* / public static void main（String args []）{System。出。 println（“我爱Java！”）; //一世？您是否可以使用？

注释

是程序中特殊的文本部分，其目的是帮助人们理解程序。评论是好程序文档的一部分。 <！ Java编程语言有三种注释： 传统注释：

列表的前五行形成一个

传统

• 注释。注释以/ *开头，以* /结尾。开放/ *和结束*之间的所有内容仅适用于人眼。没有关于“Java For Dummies，第6版”或Wiley Publishing，Inc.的信息被编译器翻译。

  代码清单3-6中的第二行，第三行，第四行和第五行有额外的星号（*）。他们被称为额外的，因为创建评论时，这些星号不是必需的。他们只是让评论看起来很漂亮。 行尾注释：
  文本//我？您？在列表中是

  行结束

• 注释。行结束注释以两个斜杠开始，并到达一行类型的末尾。再次，编译器不会翻译行尾注释中的文本。 <！ Javadoc评论： 一个 javadoc

  注释以斜杠和两个星号（/ **）开头。列表有两个javadoc评论 - 一个与文本The Displayer类…另一个与文本主要方法是… …。 javadoc评论是一种特殊的传统评论。 javadoc评论意味着被从未看过Java代码的人阅读。但是这没有意义。你怎么看javadoc的评论？

• 那么，一个名为 javadoc （还有什么？）的程序可以找到列表中的所有javadoc注释，并将这些注释转变成一个漂亮的网页。该图显示了该页面。 <！ - 1 - >

  Javadoc的评论很棒。下面是关于它们的几个很棒的东西：

  唯一需要看一段Java代码的人是编写代码的程序员。其他使用代码的人可以通过查看自动生成的网页来找出代码的功能。 因为其他人不看Java代码，所以别人不修改Java代码。 （换句话说，其他人不会在现有的Java代码中引入错误。） <！因为其他人不看Java代码，其他人不需要破译Java代码的内部工作。所有这些人需要知道的代码是他们在代码的网页上阅读的内容。

  程序员不会创建两个单独的东西 - 这里有一些Java代码和一些关于代码的文档。相反，程序员创建一个Java代码，并在代码中嵌入文档（以javadoc注释的形式）。

  

<！ - 3 - >

• 最重要的是，从javadoc注释生成网页是自动的。所以每个人的文档都有相同的格式。无论您使用哪个Java代码，都可以通过阅读图中所示的页面来了解该代码。这很好，因为任何使用Java的人都熟悉这种格式。