c#-doc-viewer for Visual Studio

时间:2012-03-09 09:50:46

标签: c# visual-studio visual-studio-2010

c#提供了记录c#-code的好方法。但我找不到任何好看的观众。我在eclipse中搜索类似java-doc-viewer的东西。此查看器允许您只需将鼠标移动到例如,即可浏览java-doc。一个班级名称。

有人知道包含此类查看器的Visual Studio 2010的良好扩展吗?

我安装了“Productivity Power Tools”-Extension。但它也不是真正的文档查看器。

编辑: 这是我搜索的图片: Example of java-doc-vieser in Eclipse

这是我能为VisualStudio找到的最好的: Doc-Viewer of Productivity Power Tools

3 个答案:

答案 0 :(得分:1)

您尝试使用CR_Documentor,如果您不介意安装Code Rush(单独用于此目的;您实际上只需要免费的“DXCore”,请查看项目的主页以获取更多信息)。

请注意,此工具不需要使用Sandcastle等工具生成上一代文档。它只需将光标放在API注释块中即可。一种方法。

显然,这有一些缺点,例如,指向其他项目的链接(例如<see/><seealso>将呈现为链接,但不会如此)。

这就是它的样子:

enter image description here

我曾经使用过一次,回到when it was still maintained by the original author Lutz Roeder,它做得很好。我从那以后就没用过它。

更新:您还可以使用ReSharper,它提供“Quick Documentation”功能。

答案 1 :(得分:1)

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

免费工具:

  • Sandcastle是最知名的,它有很多功能,但它似乎不再维护,而且使用起来相当困难(虽然Sandcastle Help File Builder使它变得更加容易,并且仍然保持着。)
  • docu更易于使用,但不是特定于.NET
  • Monodoc(来自Mono项目)

商业工具:

答案 2 :(得分:0)

您可以使用NDoc构建API文档并生成帮助文件(通常是HTML文件)

http://sourceforge.net/projects/ndoc/