Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/visual-studio/8.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
继承C#中的文档?_C#_Visual Studio_Documentation - Fatal编程技术网

继承C#中的文档?

继承C#中的文档?,c#,visual-studio,documentation,C#,Visual Studio,Documentation,在Java和Eclipse中,我习惯于@inheritDoc,它允许使用与基类/方法中相同的文档 如何在C#和Visual Studio 2010中实现类似的功能?在vanilla VS.中不存在类似功能。您最好的选择是ghostdoc或类似功能。这可在扩展管理器或中找到 NDoc3基于NDoc,是.NET开发人员的代码文档生成工具。我们的目标是制作一个快速、可扩展、多平台的.NET文档工具,它支持所有的.NET语言规范,包括但不限于C# Resharper提供了从基类复制XML文档的快捷方式。

在Java和Eclipse中,我习惯于
@inheritDoc
,它允许使用与基类/方法中相同的文档


如何在C#和Visual Studio 2010中实现类似的功能?

在vanilla VS.中不存在类似功能。您最好的选择是ghostdoc或类似功能。这可在扩展管理器或

中找到

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


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

My addin将从基类和接口方法/属性的重写、同一类中的重载复制文档,对于参数,它还将查找同一类中其他地方使用的相同命名参数


如果您想在外部文档(Sandcastle、Doxygen等)中复制文本,也可以使用扩展XML命令,但我不知道有任何“动态”继承文档以供“内部”使用的方法(intellisense等)ReSharper不仅提供了复制基类注释的快捷键,而且它还以您想要的方式在其自定义intellisense中包含了
注释。当然,这只有在您的整个团队都在使用ReSharper时才有效。
的用法解释得很好

即使这个问题已经存在了几年,而且是专门针对VisualStudio2010的。对于谷歌在这里登陆的所有人,我想添加一个我发现的答案,该答案适用于Visual Studio 2015与Sandcastle帮助文件生成器(SHFB)的结合:

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

此处是指向Sandcastle帮助文件生成器(SHFB)文档的链接:

我最终创建了一个工具,通过后处理XML文档文件来添加对替换标记的支持。可在(提供免费版本)。

有关ReSharper快捷方式和相关问题的更多信息,请参见投票:可能对此进行更新-->Microsoft“Docfx”的新文档工具可以处理此问题。这是2020年和Visual Studio 2019年的更新。从16.4版开始,IntelliSense现在将支持XML文档中的
标记。请参阅和。Visual Studio中是否有插入
//
的快捷方式?@DominicJ。您可以自己创建代码段并将其指定给快捷方式
/// <inheritdoc/>