Java中的注释,程序员必备技能

Java中的注释,程序员必备技能!!!

在程序中,需要一种方法让人们能够在程序中做一些标记来帮助人们理解代码。就像在看书的时候在或重要或精彩或空白的地方做笔记一样,通过笔记的内容就可以读到某一部分讲了哪些内容,在程序中也一样。写注释不仅仅是方便自己对代码的阅读,如果你写的代码中有良好的注释,当你的代码交给另一个人是,后这也可以很好的读懂代码的内容。
在开发的过程中,写好注释不仅是一个良好的习惯,同时也是一项技能。比如遇到了代码量特别庞大的工作,如果不写注释,时间稍微长一些就可能会忘记当时对某一部分的理解,等到回头再看到自己写的代码的时候也许自己心里就十万个为什么喷涌而出:当初我到底写了一堆什么鬼?

为了方便程序的阅读,Java语言允许在程序中注明一些说明性的文字,这就是代码的注释。编译器不会处理这些注释,多以添加了注释并不会增加程序的负担。

在Java中常用的注释有两种,单行注释和多行注释。

1.首先,单行注释

在开发过程中,若对代码说明性的文字较少就可以选择使用单行注释。 单行注释使用“//”开头,每一行“//”后面的文字都被认为是注释。 单行注释通常被用在代码行之间或者一行代码的后面,用来说明某一块代码的作用。
示例:

public class HelloWorld{
	public static void main(String[] args){
		//输出信息到控制台
		System.out.println("HelloWorld!!!");
	}
}

2.多行注释

当需要说明的文字较多需要占据多行时,可以选择使用多行注释。在两个*之间的内容都被看做是注释。
多行注释的语法:
在这里插入图片描述
示例:

/* 
  * Hello World
  *这是一个多行注释
  */
public class HelloWorld{
	public static void main(String[] args){
		System.out.println(“HelloWorld!!!);
		/*
		System.out.println(“HelloWorld!!!”);
		System.out.println(“HelloWorld!!!”);
		*/
	}
}

为了美观,很多程序员都喜欢在多行注释的每一行都写一个 * ,有的程序员也会在多行注释的开始行和结束行写一串。它们的作用只是为了美观,不对注释本身产生影响。*

3.JavaDoc文档注释

文档注释通常用来注释作者名、版本号、参数、返回值等内容。
文档注释的语法:

在这里插入图片描述
在文档注释中可以包含一个或多个各种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*),下方介绍几个标签:


@author 标识一个类的作者 @author description
@version 指定类的版本 @version info

@param 说明一个方法的参数 @param parameter-name explanation
@return 说明返回值类型 @return explanation
@see 指定一个到另一个主题的链接 @see anchor
@deprecated 指明一个过期的类或成员 @deprecated description
@serial 说明一个序列化属性 @serial description
@exception 标志一个类抛出的异常
@exception exception-name explanation
@throws 和 @exception标签一样
The @throws tag has the same meaning as the @exception tag.
@since 标记当引入一个特定的变化时 @since release


除了上述标签外还有很多,在这不做一一介绍。
后续更新使用开发工具可以提取javadoc。

注意: javadoc只能为public和protected成员进行注释。如果是私有类型的则提取的时候会被忽略掉。
2、在注释文档中,每一行开头的星号和前面的空格都会被自动忽略掉,javadoc会对所有的内容重新2进行格式化,
3、不要在嵌入式HTML中使用标题标签,javadoc会插入自己的标签,而自己的标签会发生冲突。

刚用CSDN没有多久,在编辑文章的时候试了好几次都没有成功的插入一个我想要的表格,so,不要嫌弃。如果看到这篇文章的你会插入表格,希望你可以教教我,感激不尽。

持续更新,敬请期待!!!

发布了10 篇原创文章 · 获赞 0 · 访问量 80

猜你喜欢

转载自blog.csdn.net/Godyanqi/article/details/105626450