注释

注释

 

注释作用

注释在代码当中并不会被执行，只是写给我们编程人员观看

在学习过程中，我们应该也发现要敲的代码越来越多，越来越繁琐，而且做java编程本来就很需要思维逻辑，在碰到需要使用大量代码的时候，就需要在每个关键点做好注释，让我们明白这段代码的含义，同时，如果要请教别人的话，这样也会方便别人看你的代码更加方便。

而在以后的工作当中，肯定会碰到要和别人分工合作的情况，这种时候，也是非常需要注释的。

 

注释类型

1.单行注释

//+注释内容

2.多行注释

/*+注释内容 + * /

3.文档注释

/** +注释内容+ * /

文档注释有一些功能参数提供选择使用

文档注释功能

@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info