為了讓我們的開發團隊規範文件,並易於交流,最終使用了sandcastle生成chm格式文件。
二、生成xml文件。
在vs的專案上右鍵->屬性,在彈出的對話方塊裡選擇build,在xml documentation前打勾。這樣,以後編譯的程式都會自帶乙個xml檔案了,這就是要生成幫助文件的重要檔案。
三、在程式裡新增說明。新增方法如下:
namespace danganguanli.logsystem
///
/// log4net的初始設定
///
public static void setconfig()
。。。。
其中需要說明的是這部分:
/// 類圖如下:
//////
加入以上部分後可以在生成chm文件時可以加入類圖(class diagram)。其中loghelper.png是通過手動方式匯出類圖後儲存的檔案。
php函式中文幫助文件生成工具
最近開始擼php了。俗話說 工欲善其事,必先利其器 近段時間一直在用vim做開發,所以免不了折騰一翻,把vim打造成php的ide。而在擼php的過程中,比較頭疼的就是php的函式了。我那小容量的頭腦根本記不住php裡那幾千個函式,所以找到了piv這個vim外掛程式。雖然piv解決了函式幫助文件的問...
Sandcastle生成幫助文件
準備條件 一 sandcastle help file builder help file builder and tools v2014.5.31.0 二 htmlhelp1 安裝完成後,進行操作。如下 1.開啟scandcastle檔案 選擇框架版本,以及要編譯的 dll檔案 2.修改其它配置 ...
用asDoc生成幫助文件
開始 程式 adobe flex 3 sdk command prompt 輸入asdoc source path d flexproject 你的專案 src doc classes 主類名 這樣會生成所有類的幫助文件 有時只生成乙個類,如果想生成所有 asdoc source path d fl...