「如何注释java」如何注释多行代码

本篇文章给大家谈谈如何注释java，以及如何注释多行代码对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。

本文目录一览：

• 1、java 语句如何注释
• 2、java 中的几种注释方式
• 3、为什么要为程序添加注释，在java程序中如何为程序添加注释？
• 4、如何写Java文档注释

java 语句如何注释

单行注释 // 快捷键 Ctrl+/

// M4_4aaForm fr = (M4_4aaForm) form;

多行注释 /*

*

*/

生成帮助文档的注释

/**

* Function: Action実行br

*

* Produce Describe:

*

* @param mapping

* @param form

* @param request

* @param response

* @return

* @throws SysException

* @throws DBException

*/

java 中的几种注释方式

1、单行注释：符号是：//

2、多行住释： 符号是： /* */ 可以跨多行

3、j文档注释： 符号是： /** */ 可以跨多行，

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

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

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

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

如何写Java文档注释

如何写Java文档注释(Java Doc Comments)

本文翻译自How to Write Doc Comments for the Javadoc Tool，但是精简了一些私以为不重要的东西

本文不讨论如何使用javadoc工具自动生成文档的方法，而是主要探讨应该如何去写文档注释

业余时间整理，难免有遗漏或错误，如有发现欢迎指正

转载地址：网页链接

文档注释概览

“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释，它是一种带有特殊功能的注释。

文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。

比如：

/**这是文档注释*/

/* 这是一般注释*/

// 这是一般注释

在一些IDE（比如Eclipse）中，文档注释会以不同于普通注释的颜色高亮显示。

此外，文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。

文档注释采用HTML语法规则书写，支持HTML标记(tag)，同时也有一些额外的辅助标记。需要注意的是，这些标记不是给人看的（通常他们的可读性也不好），他们的作用是为了javadoc工具更好地生成最终文档。所以，虽然有些标记写起来麻烦且看着不直观，还是要老老实实按规矩写滴。

原文地址：网页链接

关于如何注释java和如何注释多行代码的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。