如何生成我在C#中编码为Xml的文档?

时间:2013-08-28 16:21:06

标签: c# visual-studio documentation

当您在C#代码中编写Xml文档时(不确定VB是否支持),如下所示:

/// <summary>
/// Gets or sets the identity of the Mail Server that is to be used to send the email.
/// </summary>
public string MailServer
{
    get { return _mailServer; }
    set { _mailServer = value; }
}

三斜杠注释中的Xml在Intellisense中使用,但似乎在早期版本的Visual Studio(2003我认为)中有一个工具可以通过代码并组装所有这些元素(以及对象名称等)以形成完整的Xml文档。我在Visual Studio 2008,2010和2012中找不到此工具。

我很高兴开始学习如何使用Sandcastle以及所有这些,但这需要一些时间,我现在需要这个东西来处理我想要制作的一些文档。

所以问题是,因为这个工具曾经在VS中,它是否还在那里,但我一直无法找到它(被发现)?或者我必须获得一个外部工具(最好是免费的)吗?

2 个答案:

答案 0 :(得分:2)

  

生成XML文档文件属性确定是否   编译期间将生成XML文件。您设置此属性   在项目设计器的构建页面上。当此选项为时   选中,XML文档会自动发送到XML文件中,   它将与您的项目和.xml扩展名具有相同的名称。

     

为Visual C#项目生成XML文档文件

     
      
  1. 在解决方案资源管理器中选择项目后,在项目菜单上,点击* Propertie * s。

  2.   
  3. 点击构建标签。

  4.   
  5. 在“构建”页面上,选择 XML文档文件。默认情况下,文件是在指定的输出路径下创建的,例如,   的 “bin \调试\ Projectname.XML”。

  6.   

http://msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0(v=vs.100).aspx

答案 1 :(得分:1)

实际上有一个Sandcastle构建器现在可以集成到Visual Studio中。这很容易就像馅饼一样。 http://shfb.codeplex.com/