我们在编写程序的时候，总需要为程序添加一些注释，用以说明某段代码的作用，或者说明某个类的用途、某个方法的功能，以及该方法的参数和返回值得数据类型及意义。
程序注释的作用非常的大，大概就是说我们在使用注释的时候，可以有3个方向的作用：
1.永远不要过于相信自己的理解能力。意思就是说我们在编写程序的时候，可能思维可能非常的畅通，我们在后面读这段代码的时候，可以回顾当时的思路，建议添加注释。
2.可读性第一，效率第二！软件开发是一个团队做的事情，团队成员之间的沟通非常的重要，一个人写的代码，需要被整个团队的其他人所理解。
3.代码即文档！实际上，程序源代码是程序文档的重要组成部分，当我们想着吧各种软件相关文档写规范时，不要忘了把软件里最重要的文档：源代码写规范！
程序注释是源代码中一个重要部分，对于一份规范的程序源代码而言，注释应该占到源代码的1/3以上，几乎所有的变成语言都提供了添加注释的方法，一般的编程语言都提供了基本的单行注释和多行注释。
java语言提供了一种文档注释。
1.单行注释和多行注释
单行注释就是在程序中注释一行代码，java语言中，将双斜线 // 放在需要注释的内容之前就可以了
多行注释 “/*” "*/"将程序中需要注释的内容包含起来 比如：
使用方式：添加注释也是调试程序的一个重要的方法，如果我们在调试过程中发现某段代码可能有问题，可以把这段代码注释起来，让编译器忽略这段代码，再次编译，运行这个程序，如果可以正常编译。运行，则就可以说明错误就是因为这段代码引起的，这样就缩小了错误所在的范围，有利于排错。
2.文档注释
java语言还提供了一种功能更强大的注释形式：文档注释
如果编写java源代码的时候，添加了合适的文档注释，然后通过JDK提供的javadoc工具可以直接将源代码里的文档注释提取成一份系统的API文档。
什么是API文档？
答：当我们开发一个大型的软件的时候，需要定义成千上万的类，而且需要很多的人参与开发。每个人都会开发一些类，并在类里定义一些方法、Field提供给其他人使用，但其他人怎么知道如何使用这些类和方法呢？
这个时候需要提供一份说明文档，用于说明每个类、每个方法的用途。放其他人使用一个类或者使用一个方法时，他无需关心这个类或这个方法的具体实现，他只要知道这个或者这个方法的具体实现，他只要知道这个类这个方法的功能即可，然后使用这个类或方法来实现具体的目的，也就是通过调用应用程序接口（API）来编程。API文档就是用以说明这些应用程序接口的文档。对于java语言而言，API文档通常详细说明了每个类、每个方法的功能以及用法。
java语言中提供了大量的基础来，所以甲骨文公司也未这些基础类提供了相应的API文档。用于告诉开发者如何使用这些类，以及这些类里面包含的方法。
在网上搜索Api就能下载了，可以下载中文汉化的版本，不然看不懂。
文档注释可以帮我们生成一个API。 这里用到的一个命令 javadoc
文档注释的使用方式
以 " /**" 开始 “ */ ” 结尾
使用方法:
package yeeku;
/**
*Description;
*<br>网站:<a href="https://www.nangesz.com">男哥恋爱教育</a>
*<br>Copyright (c),2001-2012，Nange
*<br>This program is protected by copyright laws.
*<br>Program Name:
*<br>Date:
*@author Nange
*@version 1.0
*/
public class Test
{
/**
*简单测试Field
*/
punlic int age;
/**
*Test类的测试构造器
*/
public Test()
{
}
}
编译结果
效果展示
跟人感觉这样的学习方式和讲课一样，我这边进展的速度很慢，以后我感觉改成 就是分享自己在学习过程中遇到的一些难题，会出现的错误 然后解决方法吧。
加油！
共勉
网友评论