文档页面 [英] Documentation pages

问题描述

您好。

我正在使用Sandcastle来制作API的文档。 
我如何编写不属于API的文档页面？比如欢迎页面？

感谢
Ronen

Hello.

I`m using Sandcastle to make the documentation of the API. 
How do i write documentation pages that are not part of the API? like a welcome page for example?

Thanks
Ronen

推荐答案

您可以使用包含HTML的文件，或者首选方法，Microsoft辅助标记语言（MAML），用于创建通常称为"概念内容"的主题。 如何将它们合并到帮助文件中取决于您使用的工具（即 Sandcastle帮助文件生成器或 DocProject ）。 我建议使用其中一个，因为它们都提供了编写主题的环境，并会自动将内容合并到帮助文件中。 有关创建概念性内容的详细信息，请参阅其帮助文件。 有关MAML本身的更多信息，请参阅 Sandcastle样式项目中提供的MAML指南。

Eric

You can use files containing HTML or, the preferred method, Microsoft Assistance Markup Language (MAML) to create the topics typically referred to as "conceptual content".  How you merge them into your help file will depend on the tool you are using (i.e. Sandcastle Help File Builder or DocProject).  I'd recommend using one of those as they both provide an environment for writing the topics and will merge the content into the help file for you automatically.  See their help files for more information on creating conceptual content.  For more information on MAML itself, see the MAML Guide available from the Sandcastle Styles project.

Eric

这篇关于文档页面的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！