如何写好java代码注释

写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。

创新互联专注为客户提供全方位的互联网综合服务，包含不限于网站设计、成都网站建设、淮南网络推广、微信小程序、淮南网络营销、淮南企业策划、淮南品牌公关、搜索引擎seo、人物专访、企业宣传片、企业代运营等，从售前售中售后，我们都将竭诚为您服务，您的肯定，是我们最大的嘉奖；创新互联为所有大学生创业者提供淮南建站搭建服务，24小时服务热线：13518219792，官方网址：www.cdcxhl.com

这个时候，{@link}与@see，这2个javadoc注解就派上用场了，

不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂。方便你我他。

@see 标签允许用户引用其他类的文档。具体使用方式如下：

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#方法名称

@see fully-qualified-classname#属性名称

我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。

但是，{@link}这个却可以随便放。

具体使用方法和上面那个@see是一样的。

实际效果，看下面的图

java 怎样给源代码添加注释

1、单行(single-line)--短注释：//……

单独行注释：在代码中单起一行注释，

注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。

注释格式：/*

注释内容

*/

行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。

注释格式：//

注释内容

行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。

注释格式：代码

+

8（至少4）个空格

+

//

注释内容

2、块(block)--块注释：/*……*/

注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成：

/*

*

注释内容

*/

3、文档注释：/**……*/

注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符

/**......*/

...

为什么要为程序添加注释，在java程序中如何为程序添加注释？

注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能，java里面注释代码，可以分为行注释和块注释，方法注释等。

行注释就是在需要注释的代码前加 //

块注释则是用 /* 和 */ 把文本段落框起来即可