设计模式的 Java 注释？

design-patterns java annotations

2022-09-03 05:26:20

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

例如，当我编写构建器时，我想用.@Builder

以这种方式进行注释可以立即清楚地了解代码实现的内容。此外，注释的 Javadoc 可以引用生成器模式的说明。此外，通过使用进行注释，可以轻松地从构建器实现的 Javadoc 导航到 Javadoc。@Builder@Builder@Builder@Documented

我正在放慢为代码中的模式和习语积累一小组这样的注释的速度，但是如果存在更完整的现有项目，我想利用它。如果没有这样的项目，也许我可以通过将其分拆为单独的模式/成语注释项目来分享我所拥有的内容。

更新：我创建了模式注释项目来响应此讨论。欢迎投稿！这是@Builder

答案 1

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

答案 2

这是一个有趣的解决方案，但我一直想知道你用这个解决的真正问题是什么？或者换句话说，你从使用这样的东西中得到什么，你没有通过你的班级顶部关于它的用法的适当评论得到什么？

我可以想到一些缺点，但除了这是记录代码的很好的标准化方式之外，我想不出其他好处。

缺点是：：