如何使用SandCastle创建C#文档

时间:2013-12-31 07:05:01

标签: c# xml

我正在使用Sand Castle和Visual Studio 2010为我的C#代码创建文档。 我可以使用带有C#代码的xml注释创建文档。但它在类,类,方法等文档中显示所有内容。但我不想生成私有类文档。我试图找出,但我没找到。

所以,Any-one可以帮助我实现这一目标。提前谢谢。

1 个答案:

答案 0 :(得分:2)

要使一切顺利进行,您必须添加文档帮助,以便与classmethodproperties等相关联。要将XML文档添加到其中任何一个,只需输入///在每个函数,类等的前一行,它将生成所有标记,然后您可以填写有关它们的信息。

例如,

///
public Class1()

您将在Visual Studio中看到自动生成的XML帮助部分,

 /// <summary>
 ///              //You can add description here....
 /// </summary>
 public Class1()
 {

生成这些标记后,您可以按照Documentation Generation

上发布的说明进行操作