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

前端之家收集整理的这篇文章主要介绍了JavaDocs的最佳实践 – 接口,实现或两者兼而有之?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
我有一个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,因此它创建了到接口的链接.

猜你在找的Java相关文章