2019獨角獸企業重金招聘Python工程師標準>>>

????? Sandcastle是微軟提供的一個根據XML注釋和DLL文件生成幫助文件的工具，目前是在CodePlex上的一個開源項目，可以去這里下載：Sandcatle 項目 Sandcastle 本身是一個console的程序，為了方便使用，我們可以使用他的GUI版本：Sandcastle Help File Builder。

第一步，為你寫的代碼添加XML注釋

我們創建一個簡單的ClassLibrary1項目最為示范：

using System; using System.Collections.Generic; using System.Text; namespace ClassLibrary1 {/// <summary>/// A sample class to show something using Sandcastle/// </summary>public class SampleClass{private string _propertyValue;/// <summary> /// Gets or sets the property value./// </summary>/// <value>The property value.</value>public string Property{get{return _propertyValue;}set{_propertyValue = value;}}/// <summary>/// Determines whether the property is null./// </summary>/// <returns>/// <c>true</c> if property is null; otherwise, <c>false</c>./// </returns>public bool IsPropertyNull(){bool result = false;if (this.Property == null){result = true;}return result;}/// <summary>/// Determines whether the property is null./// </summary>/// <returns>/// <c>true</c> if property is empty; otherwise, <c>false</c>./// </returns>/// <example>/// This example shows how you might use this method:/// /// <code>/// SampleClass sample = new SampleClass();/// /// if (sample.IsPropertyEmpty())/// {/// Console.WriteLine("The property is empty");/// }/// else/// {/// Console.WriteLine("The property contains value " + sample.Property);/// }/// </code>/// </example>public bool IsPropertyEmpty(){bool result = this.IsPropertyNull();if (!result){result = (Property.Trim().Length == 0);} return result;}}}

代碼很簡單，注意其中的XML注釋。

打開項目的屬性，在“Build”選項中，確保“XML documentation file:”被選中了。

第二步，編譯這個項目，你會看到生成的DLL文件和XMl文件：

第三步，打開 Sandcastle Help File Builder

第四步，修改設置

在項目的屬性窗口，你可以根據需要修改一些設置。

第五步，生成文檔

轉載于:https://my.oschina.net/lichaoqiang/blog/492307

總結

以上是生活随笔為你收集整理的Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。