我正在使用YARD为我的rails应用程序生成文档,其中makrdown是脚本解析器。大多数文档功能都是开箱即用的。不过,我还想将模型属性记录为一个,在一个模型和两个模型上记录可用属性的列表,以描述它们的语义。
我在yard中找不到任何特殊的支持,我基本上只需要在类注释中列出属性。是否有方法记录动态生成的模型属性,以便它们像标准属性/方法一样出现在文档中?
我已经使用annodate models gem在类列表的顶部生成了一个基本的模式转储,但这并不是我真正想要的。
最佳答案
在搜索了很长一段时间之后,我将属性的文档punted并手动添加到模型文件中。这当然不理想,但希望模型结构不会有太大变化。
我为项目创建了一个.yardopts文件,并使用yard命令行选项创建了两个用于标记这些内容的新标记:
--type-name-tag 'attribute:Attributes' --type-name-tag 'association:Associations'
它们为我提供了用于标记属性和关联的特定标记;它们将在文档中的“属性”和“关联”标题下分组显示。我可以补充一下:
# @attribute name [String] The name of the object
# @association relatedObjs [Array<AnotherClass>] Objects needed to perform a certain function
也许有人会为yard编写一个插件,解析注释模型输出。
关于ruby - 使用YARD的文档模型属性,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/5348309/