设计模式的Java注释？

是否有维护模式注释的项目？

例如,当我编写构建器时,我想用它来标记它@Builder.

以这种方式进行注释会立即提供代码实现的清晰概念.此外,@Builder注释的Javadoc 可以引用构建器模式的解释.此外,@Builder通过使用注释@Builder,可以轻松地从构建器实现的Javadoc导航到Javadoc @Documented.

我正在减慢为我的代码中的模式和习语积累一小部分这样的注释,但是我想利用一个更完整的现有项目(如果存在的话).如果没有这样的项目,也许我可以通过将其分解为单独的模式/习语注释项目来分享我拥有的内容.

更新:我已经创建了Pattern Notes项目以回应此讨论.欢迎捐款!这是@Builder

这似乎是对我的注释滥用.当然,我可以理解为什么你可能想要注意一个类有助于实现的设计模式,但只是使用Javadoc和/或类的名称似乎更合适.您正在使用的模式的名称对代码本身并不重要......模式只是解决问题的常用方法的指南.注释就足够了,而不是为您使用的每个模式创建一个新文件.

这是一个有趣的解决方案,但我一直想知道你正在解决的问题是什么？或者换句话说,你从使用类似的东西得到什么,你在课堂上对它的用法做了适当的评论？

我可以想到一些缺点,但除了这是记录代码的良好标准化方法之外,我无法想到其中的好处.

缺点是,即:

程序员要思考的另一件事,这绝不是一件好事

没有注释的模式可能会令人困惑 - 有人可能忘了记录它,但也许它不是一种模式......？

你能真正注释所有模式吗？那些与单个类/方法无关的模式,例如三层体系结构模式,线程池,甚至是MVC？

Michael Hunger和我已经开始了一个用于注释的开源项目,以指定类所属的模式.我们在开始阶段是正确的,但很想听听你的意见.

我想采用KISS原则,以便人们使用注释尽可能简单.例如,如果您正在编写适配器,则可以简单地说:

@AdapterPattern
public class EnumerationIteratorAdapter implements Enumeration {
  ...
}

当然,您可以根据需要指定更多信息,例如角色,参与者和评论.我们希望这将使开发人员能够轻松地清楚地标记他们的课程.

项目主页位于http://www.jpatterns.org,您也可以从中访问初始源树.如果您想为该项目做出贡献,请联系我在javaspecialists dot eu的heinz.

亨氏(Java专家通讯)