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

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

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

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

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

想要自动添加注释,首先需要对eclipse进行一些设置。

打开Eclipse,然后点击->windows->preferences->Java->code styles->code templates->comments->types->点击右侧的edit进行编辑,在打开的编辑窗口中修改下面的文字

/**

* @author ${user}

*

* ${tags}

*/

替换成

/**

* @author 你的名字

*

* ${tags}

*/

上面的 *** 作对应的图片是这样的:

这样作者就修改成你的名字了,更多的信息可以点击本编辑窗口上面的insert varibles按钮,会d出一些文件名称,项目名称等参数,你可以选择性地添加到你的注视中。

然后在你的类中,你只要敲入/**然后换行,注释就自动滴添加到你的代码中了~希望能帮上你的忙~^_^

追问:

这只是文档前的版权声明注释,如果要在文档中对代码添加注释,里面带上修改时间,如何弄

回答:

这样弄哈~

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

这样,注释的//就会缩进了,而不是顶在行首了~


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

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

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

发表评论

登录后才能评论

评论列表(0条)

保存