为什么要为程序添加注释,在java程序中如何为程序添加注释?

为什么要为程序添加注释,在java程序中如何为程序添加注释?,第1张

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

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

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

1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。 注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式:// 注释内容 行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。 注释格式:代码 + 8(至少4)个空格 + // 注释内容

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

3、文档注释:/**……*/ 注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...

写在代码外面的注释:在要添加注释的地方输入 /** 然后在改行回车,就可以在里面写自定义注解。

写在代码里面的注释:输入 // 可以进行一行注释,该注释可以写在要注释的代码行上方或同一行的后方。


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/bake/11750644.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-18
下一篇 2023-05-18

发表评论

登录后才能评论

评论列表(0条)

保存