在部署API时在代码中保留注释

Question

我正在为WCF服务创建API。我需要确保评论包含在dll中。我该怎么做？

Answer 1

您需要在项目属性的构建选项中选择“XML文档文件”，然后再部署DLLNAME.xml文件。

Answer 2

使用XML文档注释，稍后可以将其编译为帮助文件。

XML文档评论：
http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

构建帮助文件：
http://msdn.microsoft.com/en-us/library/x4sa0ak0%28v=vs.80%29.aspx

/// <summary>
/// Retrieves an integer from somewhere.
/// </summary>
/// <returns>Some integer</returns>
public int GetSomeInt()
{

}