Eclipse用法和技巧四:生成说明文档1
写代码经常要添加注释的,java代码的注释也可以分为两种。单行注释以“//”作为开头就可以。段落注释在第一行开头添加“/*”,在最后一行结尾添加“*/"即可。这里介绍一种添加注释的方法,其注释的数据域和方法,能在Eclipse环境下,在调用处显示出来。上图:
步骤一:在要添加说明的方法上一行输入"/**"
步骤二:回车
步骤三:查看效果
补充说明下:这种添加注释的方法专门为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。JavaDoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过JavaDoc就可以同时形成程序的开发文档了。
怎么通过JavaDoc形成程序的开发文档就是接下来要介绍的。
上一篇文章,Eclipse用法和技巧三:自动生成Main方法2:
http://blog.csdn.net/ts1122/article/details/8769426
下一篇文章,Eclipse用法和技巧五:生成说明文档2 :
http://blog.csdn.net/ts1122/article/details/8798127
版权声明:本文为博主原创文章,未经博主允许不得转载。
如果一件事情你觉得难的完不成,你可以把它分为若干步,并不断寻找合适的方法。最后你发现你会是个超人。不要给自己找麻烦,但遇到麻烦绝不怕,更不要退缩。
电工查找电路不通点的最快方法是:分段诊断排除,快速定位。你有什么启示吗?
求知若饥,虚心若愚。
当你对一个事情掌控不足的时候,你需要做的就是“梳理”,并制定相应的规章制度,并使资源各司其职。
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步