只提一个简单的问题

时间:2008-09-28 10:11:20   来源:论坛整理  作者:  编辑:chinaitzhe
谁知道关于 注释标签 @author、@version、@parameter等等这类注释标签在 doc 中什么包里哪个类中?还有想问下大家平时都用到这些来写代码吗?
网友回复:估计规范的商业编码需要这些吧 我不知道 等待用过的人给答案吧
网友回复:在javadoc生成的文档里
网友回复:这些是javadoc标签。使用这些标签不权可以使你的代码写的更有一定的规范,而且也使得别人易懂该方法(类)是用来做什么的!
如:
Java code





Code highlighting produced by Actipro CodeHighlighter (freeware)

http://www.CodeHighlighter.com/







            /**

         * 根根**ID来删除其相关信息

          * @param id 记录ID

         * @author xiaoyang

         * @throws BaseException

         */

        public  void deleteRecheckupRetrainInfo(String id) throws BaseException {

            if(StringUtils.isNotEmpty(id)){

                dao.getSqlMapClientTemplate().update("updateRecheckupRetrainInfoById",id);

            }

        }






网友回复:楼主可真执着啊!
这些只是在写文档注释中使用
/**
*@author 作者名
*
*@version 版本号
*/
这类标签就不是方法,又不是属性,不包含在什么包什么类中。

主要是生成文档的时候提供一些更加详细的信息,是专业的一种表现,也是一个合格程序员的习惯。
网友回复:嘿嘿,我现在的学习阶段只要是被我看到了,如果不重要的,就不深入,但是最起码要花点小心思记一下只是点。
关键字:

相关文章

    无相关信息

文章评论

共有 0 位网友发表了评论 此处只显示部分留言 点击查看完整评论页面