java代码添加注释 java代码如何注释

java代码中添加标记表示代码没写完一、作用:1、可以大大java代码添加注释的提高开发效率 。代码量非常大java代码添加注释的项目,在某一行中需要在后续阶段实现一个功能,如果不标注下次再找的时候就非常困难java代码添加注释了 。2、在团队合作中,还可以告诉别人某处敏感代码的状态 。
二、以下为常见的两种注释标记:1、// TODO: 表示在此处将要实现的功能 , 提醒你在后续阶段将会在此处添加代码
?
2、// FIXME: 表示此处的代码逻辑有出入,或者根本不能运行,提醒你在后续阶段将会修改此处代码
?
3、// 在Eclipse中可以自定义标记
例如: // XXX:表示此处的代码虽然实现了功能,但是性能太低,提醒你需要在后续阶段优化;
Java如何进行单行注释和多行注释?(1)单行注释:以“ //”开头后面接所要加的说明的内容 。如下面所示://定义变量aint a = 10;//定义变量bint b = 20;上面的语句中,在编译的过程就会直接略过注释,只会编译 int a = 10 和 int b = 20这两句 。由此可见注释只是起着说明的作用 。
(2)多行注释:以“/*”开头,以“*/”结尾 。假设当你要说明你所写的代码的功能时 。要说明的内容有很多 。如果全部放在同一行会显得很难看 。所以一般会用多行来写,如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明 。但如果有10行说明就要按十个“//”这显示很麻烦,所以这时就可采用多行注释 。上面的可改成:/*说明说明说明说明*/也可以这样/* 说明说明说明说明 */
【java代码添加注释 java代码如何注释】(3)文档注释:以“/**”开头,以“*/”结尾 。文档注释主要是生成文档的 。
java代码如何快速添加作者描述的注释最好能有详细的图解Window --Preferences-Java-Editor-Templates ,
在这里new一个自己的插入注释的快捷方式名称,具体设置如下:
Name处输入 remark(任意你喜欢的名称)
context处选 java 后边勾选Automatically insert复选框
Description 这里可以任意输入描述
Pattern :(自定义格式)
/**
* @author ${user}
* @date : ${date} ${time}
*/
到这里全部设置完毕,下面 OK,找个java类,找个空白处测试一下,输入remark(前面写的那个Name名称),
再alt /应该按一下就能看到刚才的Description的内容 。
如何在java程序中添加注释1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释,注释前最好有一行空行,并与其后的代码具有一样的缩进层级 。如果单行无法完成 , 则应采用块注释 。注释格式:/* 注释内容 */ 行头注释:在代码行的开头进行注释 。主要为了使该行代码失去意义 。注释格式:// 注释内容 行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释 。一般与代码行后空8(至少4)个格 , 所有注释必须对齐 。注释格式:代码8(至少4)个空格// 注释内容
2、块(block)--块注释:/*……*/ 注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述 。一般位于一个文件或者一个方法的前面 , 起到引导的作用,也可以根据需要放在合适的位置 。这种域注释不会出现在HTML报告中 。注释格式通常写成: /* * 注释内容 */
3、文档注释:/**……*/ 注释若干行 , 并写入javadoc文档 。每个文档注释都会被置于注释定界符 /**......*/ ...
为什么要为程序添加注释,在java程序中如何为程序添加注释?注释是用来给开发者或者是软件后续的维护者来看的 。一般是用来描述这一段代码或者是程序做了些什么样的事情 。实现了哪些功能,java里面注释代码 , 可以分为行注释和块注释,方法注释等 。
行注释就是在需要注释的代码前加 //
块注释则是用 /*和*/把文本段落框起来即可
java开发时怎么自动添加注解想要自动添加注释,首先需要对eclipse进行一些设置 。
打开Eclipse,然后点击-windows-preferences-Java-code styles-code templates-comments-types-点击右侧的edit进行编辑,在打开的编辑窗口中修改下面的文字
/**
* @author ${user}
*
* ${tags}
*/
替换成
/**
* @author你的名字
*
* ${tags}
*/
上面的操作对应的图片是这样的:
这样作者就修改成你的名字了,更多的信息可以点击本编辑窗口上面的insert varibles按钮,会弹出一些文件名称 , 项目名称等参数,你可以选择性地添加到你的注视中 。
然后在你的类中,你只要敲入/**然后换行 , 注释就自动滴添加到你的代码中了~希望能帮上你的忙~^_^
追问:
这只是文档前的版权声明注释,如果要在文档中对代码添加注释,里面带上修改时间 , 如何弄
回答:
这样弄哈~
1.开始还是打开Eclipse,然后点击-windows-preferences-Java-code styles-code templates-comments
2.下一步选择methods,而不是types 。然后edit,insert varibles,添加上date变量 , 长下面这个样子 。
然后你在你的函数上面同样是敲入/**回车,就出现了修改的日期了
补充:
对于那个行首出现注释的问题是java的代码风格的问题,可以这样改
打开Eclipse,然后点击-windows-preferences-Java-code styles-formatter
-edit-comment 的标签页-never indent line comments on first column
这样,注释的//就会缩进了,而不是顶在行首了~
关于java代码添加注释和java代码如何注释的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站 。

    推荐阅读