有助於手冊的提示
以下是那些希望為 PHP 手冊做出貢獻的人員的提示列表:
- 請遵循手冊的樣式指南。為確保一致性,請確保始終遵循手冊的樣式指南 。
- 執行拼寫和語法檢查。確保使用正確的拼寫和語法 - 否則所呈現的資訊可能更難以同化,並且內容看起來不那麼專業。
- 請簡明扼要地解釋。避免漫無目的地向想要快速引用它的開發人員清楚簡明地呈現資訊。
- 將程式碼與其輸出分開。這為開發人員提供了更清晰,更簡單的程式碼示例。
- 檢查頁面部分的順序。確保正在編輯的手冊頁的所有部分都按正確的順序排列。手冊中的一致性使得更容易快速讀取和查詢資訊。
- 刪除 PHP 4 相關內容。鑑於它現在的年齡,PHP 4 的具體提及不再相關。應該從手冊中刪除它,以防止用不必要的資訊捲起它。
- 正確的版本檔案。在文件中建立新檔案時,請確保將檔案的修訂版 ID 設定為空,如下所示:
<!-- $Revision$ -->
。 - 將有用的註釋合併到手冊中。一些評論提供了手冊可以從中受益的有用資訊。這些應該合併到主頁的內容中。
- 不要破壞文件構建。始終確保在提交更改之前正確構建 PHP 手冊。