【C#.Net】為方案加入DocFX自動產生說明文件

  • 2734
  • 0

每一個專案都應該至少要有一份說明文件,來告訴使用者要如何使用,在專案維護的過程中,說明文件也需要一併被維護,才能維持專案內容與文件內容的一致性,但往往在忙碌之餘,總能為自己找來許多理由,將文件的維護一延再延,最後差異太大時而不得不放棄,僅能依靠口耳相傳來傳承,有朝一日一旦失傳,則要後人花費大量的時間來 try and error 才能一窺究竟,曠日廢時又容易失真。因此自動產生說明文件的工具就顯得非常重要,DocFX 就是一款如此貼心的工具,讓我們只要養成撰寫程式註解的習慣,便可在編譯之時,旋即產生專業的說明文件,省去額外維護與排版的時間,而可以專心在重點項目上面,真是快哉~~

...繼續閱讀 »