ch10-6: review

pull/1/head
chai2010 2016-01-08 16:07:44 +08:00
parent d009337c0f
commit 88c00d3cc6
1 changed files with 11 additions and 19 deletions

View File

@ -1,25 +1,22 @@
## 10.6. 包和命名
在本節中我們將提供一些關於Go語言獨特的包和成員命名的約定。
在本節中, 我們將提供一些關於如何遵循Go語言獨特的包和成員的命名約定.
當創建一個包一般要用短小的包名但也不能太短導致難以理解。標準庫中最常用的包有bufio、bytes、flag、fmt、http、io、json、os、sort、sync和time等包。
當創建一個包, 一般要用短小的包名, 但也不能太短導致難以理解.
標準庫中最常用的包有 bufio, bytes, flag, fmt, http, io, json, os, sort, sync, 和 time 等包.
它們的名字都簡潔明了。例如不要將一個類似imageutil或ioutilis的通用包命名爲util雖然它看起來很短小。要盡量避免包名使用可能被經常用於局部變量的名字這樣可能導致用戶重命名導入包例如前面看到的path包。
它們的名字都簡潔明了. 例如, 不要將一個類似 imageutil 或 ioutilis 的通用包命名爲 util,
雖然它看起來很短小. 要盡量避免包名使用經常被用於局部變量的名字, 這樣可能導致用戶重命名導入包, 例如前面看到的 path 包.
包名一般采用單數的形式。標準庫的bytes、errors和strings使用了複數形式這是爲了避免和預定義的類型衝突同樣還有go/types是爲了避免和type關鍵字衝突。
包名同時采用單數的形式. 標準庫的 bytes, errors, 和 strings 使用了複數是爲了避免和預定義的類型衝突, 同樣還有 go/types 是爲了避免和關鍵字衝突.
要避免包名有其它的含義。例如2.5節中我們的溫度轉換包最初使用了temp包名雖然併沒有持續多久。但這是一個糟糕的嚐試因爲temp幾乎是臨時變量的同義詞。然後我們有一段時間使用了temperature作爲包名雖然名字併沒有表達包的眞實用途。最後我們改成了和strconv標準包類似的tempconv包名這個名字比之前的就好多了。
要避免包名有其他的含義. 例如, 2.5節中我們的溫度轉換包最初使用了 temp 包名, 雖然併沒有持續多久. 這是一個糟糕的做法, 因爲 `temp` 幾乎是臨時變量的同義詞. 然後我們有一段時間使用了 temperature 作爲包名, 雖然名字併沒有表達包的眞是用途. 最後我們改成了 tempconv 包名, 和 strconv 類似也很簡潔明了.
現在讓我們看看如何命名包的襯衣. 由於是通過包的導入名字引入包里面的成員, 例如 fmt.Println, 同時包含了包和成名的描述信息(翻譯障礙). 我們併不需要關註Println的具體內容, 因爲 fmt 已經包含了這個信息. 當設計一個包的時候, 需要考慮包名和成員名兩個部分如何配合. 下面有一些例子:
現在讓我們看看如何命名包的成員。由於是通過包的導入名字引入包里面的成員例如fmt.Println同時包含了包名和成員名信息。因此我們一般併不需要關註Println的具體內容因爲fmt包名已經包含了這個信息。當設計一個包的時候需要考慮包名和成員名兩個部分如何很好地配合。下面有一些例子
```
bytes.Equal flag.Int http.Get json.Marshal
```
我們可以看到一些常用的命名模式. strings 包提供了字符串相關的諸多操作:
我們可以看到一些常用的命名模式。strings包提供了和字符串相關的諸多操作
```Go
package strings
@ -33,9 +30,9 @@ type Reader struct{ /* ... */ }
func NewReader(s string) *Reader
```
string 本身併沒有出現在每個成員名字中. 因爲用戶會這樣引用這些成員 strings.Index, strings.Replacer 等.
字符串string本身併沒有出現在每個成員名字中。因爲用戶會這樣引用這些成員strings.Index、strings.Replacer等。
他一些包, 可能隻描述了單一的數據類型, 例如 html/template 和 math/rand 等, 隻暴露一個主要的數據結構和與它相關的方法, 還有一個 New 名字的函數用於創建實例.
它一些包可能隻描述了單一的數據類型例如html/template和math/rand等隻暴露一個主要的數據結構和與它相關的方法還有一個以New命名的函數用於創建實例。
```Go
package rand // "math/rand"
@ -44,11 +41,6 @@ type Rand struct{ /* ... */ }
func New(source Source) *Rand
```
這可能導致一些名字重複, 例如 template.Template 或 rand.Rand, 這就是爲什麽這些種類的包的名稱往往特别短.
另一個極端, 還有像 net/http 包那樣含有非常多的名字和不多的數據類型, 因爲它們是要執行一個複雜的複合任務. 盡管有將近二十種類型和更多的函數, 包中最重要的成員名字卻是簡單明了的: Get, Post, Handle, Error, Client, Server.
有包net/http這樣有很多名字沒有很多結構,因爲他們執行一個複雜任務。盡管二十類型和更多的功能,包最重要的成員最簡單的名字:Get、Post、處理、錯誤,客戶端,服務器。
這可能導致一些名字重複例如template.Template或rand.Rand這就是爲什麽這些種類的包名往往特别短的原因之一。
在另一個極端還有像net/http包那樣含有非常多的名字和種類不多的數據類型因爲它們都是要執行一個複雜的複合任務。盡管有將近二十種類型和更多的函數但是包中最重要的成員名字卻是簡單明了的Get、Post、Handle、Error、Client、Server等。