Java 文档中重要术语和模式的词汇表放在哪里？

你好

我想在代码中记录某些模式，以便建立一致的术语（以便简化有关软件的通信）。然而，我不确定在哪里定义这些术语。为了达到同一水平，举个例子：

我有一个代码生成器。此代码生成器从解析器接收特定的InputStructure（是的，名称InputStructure可能不太理想）。然后将该输入结构转换为各种后续数据结构（如验证过程的抽象描述）。这些数据结构中的每一个都可以转换为同一数据结构的另一个值，也可以转换为下一个数据结构。在某种程度上，这听起来应该像管道和过滤器。
有鉴于此，我将采用数据结构并构造相同数据结构的值的操作称为转换，而将采用数据结构并生成不同后续数据结构的操作称为派生。派生包含代码的字符串的最后一步称为发射。（因此，总体而言，codegenerator接受输入结构并进行变换、变换、派生、变换、派生和最终发射）

我认为强调这些术语在交流中是有益的，因为这样就很容易谈论事情。如果你听到“转换”，你就知道“好的，我只需要考虑这两种数据结构”，如果你听到“发射”，你就知道“好的，我只需要知道这个数据结构和目标语言”

但是，我在哪里记录这些模式？当前的代码库使用访问者并提供类似ValidatorTransformationBase（或InputStructureTranformationBase，等等）的类

我真的不想在接口中添加这些术语的定义，因为在这种情况下，我必须在每个接口上重复我自己，这显然违反了DRY

我正在考虑通过添加更多的接口来强调转换和派生之间的区别（我必须为TransformationBase类考虑一个更好的名称，但是我可以这样做：ValidatorTransformation扩展ValidatorTransformationBase，或者ValidatorDerivationFromInputStructure扩展InputStructureTransformation）

我还认为我应该在已经存在的doxygen文档中添加一个自定义页面，如“词汇表”或“体系结构原则”，其中包含这些原则。唯一的缺点是投稿人需要找到此页面才能真正了解这一点

在你看来，我是错过了一些可能性，还是我判断出了一些错误

---

--在这方面，您可以将它们粘贴到定义接口的包中的文件中。您可以尽可能深入包层次结构。

您可以将它们粘贴到定义接口的包中的文件中。您可以尽可能深入包层次结构。

我已经看到一些笔源代码软件附带自述开发人员，这是一个供开发人员使用的自述文件，可以列出词汇表、RCS、Wiki URL等内容。

我看到一些开源软件附带自述开发人员，这是一个供开发人员使用的自述文件，可以列出词汇表、RCS、u等内容rls用于Wiki等