[TOC]
注釋
類型：
- block comment:
/* */ - line comment:
//
注釋方式：
- 要注釋的內(nèi)容前面進(jìn)行注釋
-
doc.go：注釋的內(nèi)容比較多
注釋規(guī)范：
- 段落的標(biāo)題：
空行{標(biāo)題}空行。example： https://golang.org/src/encoding/gob/doc.go#L15 - 簡(jiǎn)短代碼例子：前后空行羽资，代碼部分縮進(jìn)控制
- url會(huì)自動(dòng)轉(zhuǎn)化成html鏈接
- 第一句注釋比較重要：
- 做為概要句子出現(xiàn)在 godoc's package
- 注釋時(shí)必須以注釋的對(duì)象（比如函數(shù)址芯，變量）為開頭柠衍。例子：https://golang.org/pkg/regexp/#Compile蛉威，解釋Compile的注釋旦委，以Compile開頭。
的簡(jiǎn)要介紹部分
- 注釋只能使用純文本，包含復(fù)雜語(yǔ)法画机，比如html，md之類的不支持新症。
- 注釋以整個(gè)句子為一個(gè)單元步氏，如果用逗號(hào)把一個(gè)句子分成多行，實(shí)際使用go doc查看的時(shí)候徒爹，是一行荚醒，查看時(shí)，根據(jù)寬度隆嗅，自動(dòng)換行顯示
常見的注釋類型
- 普通注釋：函數(shù)注釋界阁，變量注釋，
doc.go注釋 - 已知BUG注釋：https://golang.org/pkg/bytes/#pkg-note-BUG
- Deprecated 注釋：
- Deprecated 搜索結(jié)果：https://golang.org/search?q=Deprecated:
- example：https://golang.org/src/archive/tar/common.go?#L59
文檔服務(wù)器
參考
- https://blog.golang.org/godoc-documenting-go-code
- 注釋的代碼與渲染的例子胖喳，對(duì)比兩個(gè)文檔查看效果：
