我正在为Sandcastle正在制作的技术文档编写一些概念性文档。
那里没有很多很好的例子/链接,但我开始掌握MAML。如果有人有任何寻找/理解这一点的优秀资源,我会很感激。
我希望让我的概念文档能够引用我的Documentation Sources中的一些类型。有没有办法把像“>类型”这样简单的东西链接到同样在代码中的文档?
编辑: 这是我的一个主要问题,因为我是新手。
链接到代码项的最佳方法是从实体窗口中获取它。要打开实体窗口,请转到窗口>实体参考。从这里,您可以找到适当的类型/方法/属性并将其拖到结果中的代码中。
MAML参考指南包含在Sandcastle样式下载中:http://sandcastlestyles.codeplex.com/,并且非常有助于学习如何格式化。
答案 0 :(得分:2)
您可以使用codeEntityReference创建从概念文档到参考文档的引用。详情请参阅:http://davesexton.com/blog/blogs/blog/archive/2008/05/24/maml-migration-the-next-step-in-the-evolution-of-help-authoring.aspx