標(biāo)識 | 說明 |
---|---|
-all | 顯示所有文檔 |
-c | 匹配程序?qū)嶓w時,大小寫敏感 |
-cmd | 將命令(main包)視為常規(guī)程序包,如果要顯示main包的doc,請指定這個標(biāo)識 |
-src | 顯示完整源代碼 |
-u | 顯示未導(dǎo)出的程序?qū)嶓w |
示例
輸出指定 package ,指定類型,指定方法的注釋
$ go doc sync.WaitGroup.Add
輸出指定 package ,指定類型的所有程序?qū)嶓w,包括未導(dǎo)出的
$ go doc -u -all sync.WaitGroup
輸出指定 package 的所有程序?qū)嶓w(非所有詳細(xì)注釋)
$ go doc -u sync
godoc命令主要用于在無法聯(lián)網(wǎng)的環(huán)境下,以web形式,查看Go語言標(biāo)準(zhǔn)庫和項目依賴庫的文檔。
在 go 1.12 之后的版本中,godoc不再做為go編譯器的一部分存在。依然可以通過go get命令安裝:
go get -u -v golang.org/x/tools/cmd/godoc
國內(nèi)的安裝方法
mkdir -p $GOPATH/src/golang.org/x cd $GOPATH/src/golang.org/x git clone https://github.com/golang/tools.git cd tools/cmd/godoc go install ls -alh $GOPATH/bin
通過終端查看文檔
go doc命令
$ go doc help
usage: go doc [-u] [-c] [package|[package.]symbol[.method]]
可以看到,go doc接受的參數(shù),可以是包名,也可以是包里的結(jié)構(gòu)、方法等,默認(rèn)為顯示當(dāng)前目錄下的文檔。
查看系統(tǒng)log包信息
linux@ubuntu:/usr/local/go/src/log$ go doc package log // import "log" Package log implements a simple logging package. It defines a type, Logger, with methods for formatting output. It also has a predefined 'standard' Logger accessible through helper functions Print[f|ln], Fatal[f|ln], and Panic[f|ln], which are easier to use than creating a Logger manually. That logger writes to standard error and prints the date and time of each logged message. Every log message is output on a separate line: if the message being printed does not end in a newline, the logger will add one. The Fatal functions call os.Exit(1) after writing the log message. The Panic functions call panic after writing the log message. const Ldate = 1 iota ... func Fatal(v ...interface{}) func Fatalf(format string, v ...interface{}) func Fatalln(v ...interface{}) func Flags() int func Output(calldepth int, s string) error func Panic(v ...interface{}) func Panicf(format string, v ...interface{}) func Panicln(v ...interface{}) func Prefix() string func Print(v ...interface{}) func Printf(format string, v ...interface{}) func Println(v ...interface{}) func SetFlags(flag int) func SetOutput(w io.Writer) func SetPrefix(prefix string) type Logger struct{ ... } func New(out io.Writer, prefix string, flag int) *Logger
列出當(dāng)前包中方法、結(jié)構(gòu)、常量等
查看系統(tǒng)log包中Fatal方法
linux@ubuntu:/usr/local/go/src/log$ go doc log.Fatal func Fatal(v ...interface{}) Fatal is equivalent to Print() followed by a call to os.Exit(1).
列出當(dāng)前函數(shù)和注釋說明
查看系統(tǒng)log包中Logger結(jié)構(gòu)
linux@ubuntu:/usr/local/go/src/log$ go doc Logger type Logger struct { // Has unexported fields. } A Logger represents an active logging object that generates lines of output to an io.Writer. Each logging operation makes a single call to the Writer's Write method. A Logger can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer. func New(out io.Writer, prefix string, flag int) *Logger func (l *Logger) Fatal(v ...interface{}) func (l *Logger) Fatalf(format string, v ...interface{}) func (l *Logger) Fatalln(v ...interface{}) func (l *Logger) Flags() int func (l *Logger) Output(calldepth int, s string) error func (l *Logger) Panic(v ...interface{}) func (l *Logger) Panicf(format string, v ...interface{}) func (l *Logger) Panicln(v ...interface{}) func (l *Logger) Prefix() string func (l *Logger) Print(v ...interface{}) func (l *Logger) Printf(format string, v ...interface{}) func (l *Logger) Println(v ...interface{}) func (l *Logger) SetFlags(flag int) func (l *Logger) SetOutput(w io.Writer) func (l *Logger) SetPrefix(prefix string)
列出Logger結(jié)構(gòu)定義以及Logger結(jié)構(gòu)操作的方法集
通過網(wǎng)頁查看文檔
godoc命令
$ godoc -http=:6060
godoc會監(jiān)聽6060端口,通過網(wǎng)頁訪問 http://127.0.0.1:6060,godoc基于GOROOT和GOPATH路徑下的代碼生成文檔的。打開首頁如下,我們自己項目工程文檔和通過go get的代碼文檔都在Packages中的Third party里面。
編寫自己的文檔
1、設(shè)計接口函數(shù)代碼
創(chuàng)建documents/calc.go文件
/* 簡易計算器計算自定義包 */ package documents // 一種實現(xiàn)兩個整數(shù)相加的函數(shù), // 返回值為兩整數(shù)相加之和 func Add(a, b int) int { return a + b } // 一種實現(xiàn)兩個整數(shù)相減的函數(shù), // 返回值為兩整數(shù)相減之差 func Sub(a, b int) int { return a - b } // 一種實現(xiàn)兩個整數(shù)相乘的函數(shù), // 返回值為兩整數(shù)相乘之積 func Mul(a, b int) int { return a * b } // 一種實現(xiàn)兩個整數(shù)相除的函數(shù), // 返回值為兩整數(shù)相除之商 func Div(a, b int) int { if b == 0 { panic("divide by zero") } return a / b }
2、設(shè)計Example示例代碼
創(chuàng)建documents/calc_test.go文件,給calc.go中每個函數(shù)編寫Example函數(shù)
package documents import ( "fmt" ) func ExampleAdd() { result := Add(4, 2) fmt.Println("4 + 2 =", result) // Output: // 4 + 2 = 6 } func ExampleSub() { result := Sub(4, 2) fmt.Println("4 - 2 =", result) // Output: // 4 - 2 = 2 } func ExampleMul() { result := Mul(4, 2) fmt.Println("4 * 2 =", result) // Output: // 4 * 2 = 8 } func ExampleDiv() { result := Div(4,2) fmt.Println("4 / 2 =", result) // Output: // 4 / 2 = 2 }
3、網(wǎng)頁查看文檔
注意以上兩個文件必須在$GOPATH/src路徑下,使用godoc命令創(chuàng)建文檔,用網(wǎng)頁打開顯示如下
編寫文檔規(guī)則
1、文檔中顯示的詳細(xì)主體內(nèi)容,大多是由用戶注釋部分提供,注釋的方式有兩種,單行注釋"http://"和代碼塊"/* */"注釋。
2、在源碼文件中,在package語句前做注釋,在文檔中看到的就是Overview部分, 注意:此注釋必須緊挨package語句前一行,要作為Overview部分的,注釋塊中間不能有空行。
3、在函數(shù)、結(jié)構(gòu)、變量等前做注釋的,在文檔中看到的就是該項詳細(xì)描述。注釋規(guī)則同上。
4、編寫的Example程序,函數(shù)名必須以Example為前綴,可將測試的輸出結(jié)果放在在函數(shù)尾部,以"http:// Output:"另起一行,然后將輸出內(nèi)容注釋,并追加在后面。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。如有錯誤或未考慮完全的地方,望不吝賜教。
標(biāo)簽:電子產(chǎn)品 儋州 物業(yè)服務(wù) 西雙版納 遼寧 青海 海南 安康
巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《golang 解析word文檔操作》,本文關(guān)鍵詞 golang,解析,word,文檔,操作,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。上一篇:golang逐行讀取文件的操作
下一篇:golang 字符串切片去重實例