Visual Studio c#-VisualStudio的文档查看器

pw9qyyiw 于 2023-03-03 发布在 C#

关注(0)|答案(3)|浏览(230)

c#提供了一个很好的方式来记录你的c#代码。但是我没有找到任何好的查看器。我在eclipse中搜索了类似java-doc-viewer的东西。这个查看器允许你在java-doc中浏览，只要把你的鼠标移到一个类名上。
有人知道包含这样一个查看器的Visual Studio 2010的好扩展吗？
我安装了“生产力工具”扩展，但它也没有真实的的文档查看器。
编辑：以下是我搜索的图片：

这是我能为VisualStudio找到的最好的：

visual-studio

来源：https://stackoverflow.com/questions/9631980/c-doc-viewer-for-visualstudio

3条答案

按热度按时间

thtygnil1#

如果您不介意安装Code Rush（单独用于此目的;你只需要免费的"DXCore"实际上，检查项目的主页了解更多信息）。
注意这个工具不需要使用Sandcastle这样的工具预先生成文档，只需将光标放在API注解块（例如方法注解块）中即可。
显然，这有一些缺点，例如，到其他项的链接（例如，<see/>或<seealso>将呈现为链接，但不这样工作）。
它看起来是这样的：

我曾经用过一次，很久以前的when it was still maintained by the original author Lutz Roeder，它很好地完成了它的工作。从那以后我就没有再用过它。

- 更新**：您还可以使用ReSharper，它提供了"Quick Documentation"功能。

赞(0）回复(0）举报 2023-03-03

juzqafwq2#

VS中没有任何内置的工具来查看代码的文档，您必须使用外部工具从XML文档生成文档页面。

免费工具：

Sandcastle是最有名的，它有很多特性，但似乎不再维护它，而且很难使用（尽管Sandcastle Help File Builder使它明显更容易，而且仍然维护）。
docu更易于使用，但并非特定于.NET
Monodoc（来自Mono项目）
商业工具：
VSdocman
Document! X
Doc-O-Matic
ForgeDoc：这是一个很新的，看起来很有前途：非常轻巧，使用简单，速度快，输出美观...它也比上面的其他便宜得多