将 GhostDoc 文档移动到 <include> 标记文件

Posted

技术标签:

【中文标题】将 GhostDoc 文档移动到 <include> 标记文件【英文标题】:Move GhostDoc documentation to <include> tag file 【发布时间】:2021-08-03 16:24:25 【问题描述】:

所以我有 GhostDoc Pro 并自动记录了一个项目。伟大的。 结果是,正如它在 C# 文档 put it all together 中所说的那样,与代码相比是冗长的。因此,我想使用include 标记和一个单独的文档文件来减少我的类的文档量。

所有类都是自动记录的,但文档进入类包含文件,如下所示:

/// <include file='MyMathClass.xml' path='docs/members[@name="math"]/Math/*'/>
... some code ...

和另一个班级

/// <include file='MyArtClass.xml' path='docs/members[@name="art"]/Art/*'/>
... some code ...

是否有执行此操作的功能,或者我必须手动移动每个文档标签?我希望每个类都有自己的包含文件。

【问题讨论】:

【参考方案1】:

该功能即将推出,但当前版本的 GhostDoc 不支持

【讨论】:

以上是关于将 GhostDoc 文档移动到 <include> 标记文件的主要内容,如果未能解决你的问题,请参考以下文章

Ghostdoc 不会尝试生成返回信息

使用GhostDoc为代码生成注释文档

使用GhostDoc为代码生成注释文档

GhostDoc如何获取属性的属性?

如何从 GhostDoc 规则中删除 XML 注释元素?

Ghostdoc“记录此”快捷方式不起作用