在C#中继承文档?

时间:2011-03-14 20:35:51

标签: c# visual-studio documentation

从Java和Eclipse我习惯@inheritDoc允许使用与基类/方法相同的文档。

如何在C#和Visual Studio 2010中完成类似的工作?

7 个答案:

答案 0 :(得分:14)

即使这个问题还有几年的历史,它专门针对Visual Studio 2010.对于谷歌所有人来说,我想添加一个我找到的答案,这与Visual Studio 2015结合使用也是如此。 Sandcastle帮助文件生成器(SHFB):

/// <inheritdoc/>

可用于从基类或接口继承文档。

这里是Sandcastle帮助文件生成器(SHFB)文档的链接: Using the <inheritdoc /> Tag

答案 1 :(得分:12)

香草VS中不存在。你最好的选择是ghostdoc或类似的。这可以在Extension Manager中使用,或here

答案 2 :(得分:4)

ReSharper 不仅提供了复制基类注释的快捷键,而且它实际上还包含{J}个自定义智能感知中的<inheritdoc>个注释。这仅适用于整个团队当然使用ReSharper的情况。 <inheritdoc>的使用情况很好地解释了here

答案 3 :(得分:1)

NDoc3

  

NDoc3基于NDoc,是.NET开发人员的代码文档生成工具。目标是创建一个快速,可扩展,多平台的.NET文档工具,它支持所有.NET语言规范,包括但不仅仅是C#

答案 4 :(得分:1)

Resharper提供了从基类复制XML文档的快捷方式。

答案 5 :(得分:1)

我的插件AtomineerUtils将从同一类中的重载中复制基类和接口方法/属性的覆盖文档,对于参数,它还将查找同一类中其他地方使用的同名参数

您也可以使用扩展XML命令,例如&lt; inheritdoc&gt;或者&lt; include&gt;如果你想复制外部文档中的文本(Sandcastle,Doxygen等),但我不知道“动态”继承“内部”使用文档的方式(intellisense等)

答案 6 :(得分:1)

我最终创建了一个工具来添加对替换&lt; inheritdoc /&gt;的支持。通过后处理XML文档文件来标记。可在www.inheritdoc.io处获得(免费版本)。