Boost 對於您撰寫文件的格式並沒有任何要求。如果您提交的函式庫已經有 HTML 格式的文件,則沒有理由為了遵循這裡提出的任何準則而更改它。但是,如果您目前的文件不是 HTML 格式,且無法輕鬆轉換為 HTML,或者您正從頭開始開發一個函式庫,或是您的函式庫沒有任何文件,那麼這些準則可以讓撰寫文件變得更加容易。
文件結構 一節描述了如何建構文件的內容。即使對於已經有文件的函式庫,本節也可能有所幫助。如果希望提交函式庫以供 C++ 標準委員會納入考量,則可能需要重新建構文件的內容,以確保內容符合函式庫組件的明確要求(第 17.3 節)。
HTML 設計 一節提供了撰寫 HTML 文件時應遵循的通用規則,以呈現專業且一致的外觀。本節還包含一些範本檔案,可用於快速建立文件頁面。
修訂日期2006 年 12 月 4 日
版權所有 © 2001 William E. Kempf
依據 Boost 軟體授權條款 1.0 版散布。(請參閱隨附檔案 LICENSE_1_0.txt 或複製於 https://boost.dev.org.tw/LICENSE_1_0.txt)