文档注释与多行注释的区别

多行注释与文档注释的区别: 多行注释的内容不能用于生成一个开发者文档,
而文档注释 的内容可以生产一个开发者文档。

使用javadoc开发工具即可生成一个开发者文档。

    javadoc工具的使用格式:

        javadoc -d 存放文档的路径   java的源文件 

使用javadoc工具要注意细节:
    1. 如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。
    2. 文档注释注释的内容一般都是位于类或者方法的上面的。

写注释的规范:一般单行注释是位于代码的右侧,多行注释与文档注释一般是写在类或者方法的上面的。
时间: 2024-11-03 21:58:08

文档注释与多行注释的区别的相关文章

[转]Eclipse 的快捷键以及文档注释、多行注释的快捷键

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释 4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */

Eclipse 的快捷键以及文档注释、多行注释的快捷键

其实快捷键可以自己设定:eclipse>>>window>>>preferences>>>keys Alt + / 内容提示很常用的Ctrl + 1 快速修复 Alt + 方向键 跟踪时向前向后退回前进Ctrl + Alt + 向下键快速复制行 Alt + 向上向下键 快速移动行 Ctrl + T 查看继承关系Ctrl + Shift + T 快速查看方法源代码Ctrl + Shift + O 快速导入引用包 Alt + Shift + A : 快捷键

【转载】Eclipse 的快捷键以及文档注释、多行注释的快捷键

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */ 2.

Eclipse 的快捷键以及文档注释、多行注释的快捷键 一、多行注释快捷键

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */ 2.

Eclipse 快捷键、文档注释、多行注释的快捷键

关于快捷键 Eclipse 的很多操作都提供了快捷键功能,我们可以通过键盘就能很好的控制 Eclipse 各个功能: 一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行

.NET中的注释种类,单行注释、多行注释、文档注释。。。

注释不是给编译器看的,而是给程序员看的.是程序员之间交流的一种方式.好的程序员一定要有完善的注释. .NET注释类型. 1.单行注释  // a.当代码行比较短时,注释可以放在代码后面. b.当代码行比较长时,注释一定要放在注释代码上边,而不是下边. c.快捷键:选中要注释的代码, 注释: ctrl k +ctrl c 取消注释:ctrl k + ctrl u 2.多行注释  /*  */ a.多行注释不能嵌套. 3.文档注释  /// a.快捷键 在方法头.类 .枚举.接口上边 连续输入 三个

eclipse中java的单行注释、多行注释、文档注释的快捷键

一.单行注释(也可以多行注释) 1.样式://我是被注释的内容 2.快捷键:ctrl+/   或   ctrl+shift+C 二.多行注释(也可以单行注释) 1.样式:/*我是被注释的内容*/ 2.快捷键:ctrl+shift+/ 三.文档注释 1.样式:/**我是被注释的文档*/ 2.快捷键:Alt+shift+J 3.修改文档注释的文档内容: 打开eclipse Window-->Preferences-->Java-->Code Style --> Code Templat

eclipse中单行注释,多行注释,文档注释

一.单行注释(也可以多行注释) 1.样式://我是被注释的内容 2.快捷键:ctrl+/   或   ctrl+shift+C 二.多行注释(也可以单行注释) 1.样式:/*我是被注释的内容*/ 2.快捷键:ctrl+shift+/ 三.文档注释 1.样式:/**我是被注释的文档*/ 2.快捷键:Alt+shift+J 3.修改文档注释的文档内容: 原文地址:https://www.cnblogs.com/wjune-0405/p/12228689.html

注释的基本使用与文档注释的特殊功能

注释与注解(Annotation)的区别: 注释:解释说明程序代码,并帮忙调试错误(给程序设计师阅读的)文字 注解(Annotation):用于给计算机解释说明的程序 注释分类 单行注释 : //单行注释提示 多行注释: /*多行注释提示*/ 文档注释: /** 文档注释提示*/ 文档注释的常用注解:  注意:文档注释支持html片段 文档注释的神奇妙用 原文地址:https://www.cnblogs.com/qq1452753919/p/10551458.html