.Net Core如果没有xml注释,如何构建文档

时间:2016-04-08 14:07:19

标签: c# .net xml documentation sandcastle

我正在与Sandcastle合作一段时间,我也习惯在.Net Source Reference中找到xml内联注释。它们通常与msdn上的描述完全匹配。
自.Net 4.6和.Net Core以来,似乎微软以不同的方式创建了他们的评论。
(在.Net Source Reference中找不到它们)

一个例子:
https://msdn.microsoft.com/de-de/library/system.string.padright(v=vs.110).aspx
这个方法在msdn中有注释,但我无法在源代码中找到它:
http://referencesource.microsoft.com/#mscorlib/system/string.cs,56cb688f4f1dc9e4

我想知道他们现在如何使用.Net 4.6以及他们将如何/正在使用.NET Core。 任何人都可以向我确认并解释这个吗?

编辑: 由于.Net Core是开源的,我们应该能够解决这个问题。但我找不到任何有关它的信息。

EDIT2:由于.Net Core是开源的,我认为我们应该可以访问或至少能够访问其内部“秘密”文档工具。我们还能如何进一步开发.Net Core并编写文档。 是否有人知道该工具或在何处找到它?

2 个答案:

答案 0 :(得分:14)

免责声明 MSDN工程团队的开发人员,维护旧版平台和新版平台。

首先,我们为MSDN提供了多个文档生成工具/解决方案,但核心部分始终是反射。我们利用自动工具帮助从源代码中提取API签名和注释,然后将它们保存在XML或Markdown文件中。我们使用的最新工具是DocFX http://dotnet.github.io/docfx/

其次,由于所有API签名和注释都存储在文件中,技术作者可以/允许修改它们以使它们更具可读性(现在我们在源代码和最终产品之间存在差距,对吧?)。此外,作者将添加单独的文件,即概念文档,以填写描述,代码示例和相应API的指导。

最后,所有这些文件都将转换为xliff文件进行本地化。

简而言之,这些文档是从源代码注释和编写器生成的。输入。后一个将被转移到GitHub,欢迎社区贡献。

答案 1 :(得分:3)

Microsoft似乎将评论保留在单独的文件中,并且与构建MSDN和本地化的内部工作流程完美集成。 Sandcastle曾经是一个主要的工具,但后来成为开源的,

https://sandcastle.codeplex.com/

Sandcastle因其复杂性和.NET Framework后来的变化而被放弃。

GitHub上的CoreFX repo上已有一个帖子将这些评论移回C#源文件,但由于时间紧迫,它很快就会发生,

https://github.com/dotnet/corefx/issues/230 https://github.com/dotnet/corefx/issues/6518

罗斯林方面可能还有其他一些变化,

https://github.com/dotnet/roslyn/issues/85

.NET Core的当前文档是使用DocFX构建的,

https://dotnet.github.io/api/

这也是GitHub的开源,它应该从内部文件中获取评论,

https://github.com/dotnet/docfx

让我们看看未来几个月的情况。

旁注是Xamarin有自己的文档解决方案,只有BCL部分来自Microsoft,

http://www.zdnet.com/article/microsofts-open-sourcing-of-net-the-back-story/

不幸的是,什么系统生成.NET Framework 4的当前MSDN文档。*未知。