如何在单独的文件中保留方法描述的XML注释?
-
03-07-2019 - |
题
这个问题源于这个问题 代码文档中有多少太多了?
答案之一是将xml文档保存在单独的文件中。我非常喜欢这个答案,因为当我查看代码时,文档的详细程度令人讨厌,另一方面,当通过intellisense搜索正确的方法或发布文档时,详细程度很有用。
答案是使用include标记
/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/>
还有一篇关于include标签的MSDN文章这里
我想出了如何保留摘要信息,但我不知道,我也找不到如何将方法文档放在那里。 (这比课堂总结本身更重要。
解决方案
答案很简单。阅读生成的xml文件。他们给出了分离的xml文件应该是什么样子的概念。
读取生成的xml文件以及如何描述方法(带参数等):
<member name="M:BitFactory.Logging.Logger.DoLog(BitFactory.Logging.LogEntry)">
<summary>
Really log aLogEntry. (We are past filtering at this point.)
Subclasses might want to do something more interesting and override this method.
</summary>
<param name="aLogEntry">The LogEntry to log</param>
<returns>true upon success, false upon failure.</returns>
</member>
T,M,F前缀类型,方法,字段。
不隶属于 StackOverflow