Golang 文檔 ：擴展工具 godoc 能自動提取注釋生成幫助文檔。 ~~~ ? 僅和成員相鄰 (中間沒有空行) 的注釋被當做幫助信息。 ? 相鄰行會合并成同一段落，用空行分隔段落。 ? 縮進表示格式化文本，比如示例代碼。 ? 自動轉換 URL 為鏈接。 ? 自動合并多個源碼文件中的 package 文檔。 ? 無法顯式 package main 中的成員文檔。 ~~~ Package ~~~ ? 建議用專門的 doc.go 保存 package 幫助信息。 ? 包文檔第一整句 (中英文句號結束) 被當做 packages 列表說明。 ~~~ Example 只要 Example 測試函數名稱符合以下規范即可。 | | 格式 | 示例 | | --- | --- | --- | |package | Example, Example_suffix | Example_test| |func | ExampleF, ExampleF_suffix | ExampleHello| |type | ExampleT, ExampleT_suffix | ExampleUser, ExampleUser_copy| |method | ExampleT_M, ExampleT_M_suffix | ExampleUser_ToString| 說明:使用 suffix 作為示例名稱，其首字母必須小寫。如果文件中僅有一個 Example 函數，且調用了該文件中的其他成員，那么示例會顯示整個文件內容，而不僅僅是測試函數自己。 Bug 非測試源碼文件中以 BUG(author) 開始的注釋，會在幫助文檔 Bugs 節點中顯示。 ~~~ // BUG(yuhen): memory leak. ~~~