自动生成C#项目中所有行内XML文档注释

Question

自动生成C#项目中所有行内XML文档注释

c#xamarinxamarin-studiovisual-studio-mac

4

我有一个包含100多个C#类的项目，想要生成每个变量、属性和方法的文档。在Visual Studio macOS IDE中，您可以使用///为每个方法生成文档，但是这对于所有类来说是繁琐的工作。

是否有可能在Xamarin Studio/Visual Studio for Mac中自动化此过程？如果没有，有没有其他IDE可以实现这一点？

我不想使用集成文档（如Doxygen）的程序，我需要的是能够添加内联文档的工具，我会自己添加文档（或编辑自动生成的文档）。

- Robin Bruneel

1

GhostDoc可以解决这个问题：http://submain.com/products/ghostdoc.aspx 然而，它只能生成从代码信息中派生出来的注释。如果您不使用有用的信息升级它，那么它就相当无用了。 - Caspar Kleijne

你尝试过搜索类似的问题吗？在例如这个问题中查找答案。 - Sinatr

2

自动生成文档注释的问题在于很难追踪哪些是当前无用的（只是自动生成的），哪些是有实际文档记录的有用注释。唯一能确定这点的方法就是不要自动生成它们。 - Damien_The_Unbeliever

我不太确定我理解你的观点。无论如何，您都必须记录所有类型和成员，因此每个记录实体都需要键入“///”。正如达米恩所指出的那样，生成的文档注释是完全无用的，因此您仍然需要检查每个文档注释。与实际编写文档的努力相比，三个按键是相当微不足道的。但是，如果您只是想为所有内容生成空摘要，那么使用Roslyn可能需要半小时的工作量。 - Joey

如何在Xamarin中生成待办事项列表？ - Manthan

显示剩余2条评论

2个回答

0

我使用doxygen来进行C#文档编写，它也适用于Xamarin。

- Anas EL HAJJAJI

从问题中：“我不想要一个捆绑文档的程序（比如Doxygen），…” - Damien_The_Unbeliever

好的，抱歉。我建议使用它，因为我用过并且发现它非常完美。 - Anas EL HAJJAJI

如何在Xamarin中生成待办事项列表？ - Manthan

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- vrwim · Accepted Answer

你可以使用GhostDoc或SandCastle来完成此操作。 Sandcastle是一个独立的应用程序，可以在项目文件夹中运行源代码，而Ghostdoc是Visual Studio的插件。

不幸的是，两者都无法在Mac上工作。