JavaDocs的最佳实践 – 接口,实现或两者兼而有之？

发布时间：2020-12-14 05:54:24 所属栏目：Java 来源：网络整理

导读：我有一个DAO接口和DAO的实现.接口中的 JavaDocs是Netbeans向实现DAO方法的客户端显示的内容. 显然我需要在界面中维护JavaDocs.但是它的实施呢？一方面,将它们放在那里很方便,但另一方面,它是重复的,需要它们保存在两个地方. 只是想知道其他Java开发人员做了

我有一个DAO接口和DAO的实现.接口中的 JavaDocs是Netbeans向实现DAO方法的客户端显示的内容.

显然我需要在界面中维护JavaDocs.但是它的实施呢？一方面,将它们放在那里很方便,但另一方面,它是重复的,需要它们保存在两个地方.

只是想知道其他Java开发人员做了什么.

解决方法

在我的项目中,Eclipse自动创建文档如下：

/* (non-Javadoc)
     *  @see com.comp.SomeInterface#method(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
     */
    @Override
    public void method(HttpServletRequest arg0,HttpServletResponse arg1)
            throws Exception {
        // TODO Auto-generated method stub

    }

我们使用Ant任务创建了javadoc,因此它创建了到接口的链接.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!