欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Golang中的godoc使用簡(jiǎn)介(推薦)

 更新時(shí)間:2022年10月28日 11:34:04   作者:raoxiaoya  
Godoc是go語言的文檔化工具,類似于文檔化工具godoc,類似于Python的Docstring和Java的Javadoc,這篇文章主要介紹了Golang中的godoc使用簡(jiǎn)介,需要的朋友可以參考下

go doc簡(jiǎn)介

Godoc是go語言的文檔化工具,類似于文檔化工具godoc,類似于Python的Docstring和Java的Javadoc
Godoc通過解析包含注釋的Go代碼來生成HTML或文本類型的文檔。

Golang中的godoc使用簡(jiǎn)介

學(xué)習(xí)go語法的同時(shí)為了方便查看對(duì)應(yīng)的文檔,不同的Go版本會(huì)有一些改動(dòng),所以,使用本地Go源碼生成的文檔顯然更精確。

go在1.13之前是自帶godoc的,之后的版本需要自行安裝。

go get -u golang.org/x/tools/cmd/godoc // 并沒有自動(dòng)安裝
go install golang.org/x/tools/cmd/godoc // 手動(dòng)安裝

> godoc -h

usage: godoc -http=localhost:6060
  -goroot string
        Go root directory (default "D:\\Go")
  -http string
        HTTP service address (default "localhost:6060")
  -index
        enable search index
  -index_files string
        glob pattern specifying index files; if not empty, the index is read from these files in sorted order
  -index_interval duration
        interval of indexing; 0 for default (5m), negative to only index once at startup
  -index_throttle float
        index throttle value; 0.0 = no time allocated, 1.0 = full throttle (default 0.75)
  -links
        link identifiers to their declarations (default true)
  -maxresults int
        maximum number of full text search results shown (default 10000)
  -notes string
        regular expression matching note markers to show (default "BUG")
  -play
        enable playground
  -templates string
        load templates/JS/CSS from disk in this directory
  -timestamps
        show timestamps with directory listings
  -url string
        print HTML for named URL
  -v    verbose mode
  -write_index
        write index to a file; the file name must be specified with -index_files
  -zip string
        zip file providing the file system to serve; disabled if empty

進(jìn)入到Go源碼目錄,D:\Go\src
godoc -http=:6060
掃描文件需要時(shí)間,啟動(dòng)之后有時(shí)候還要等一會(huì)。
訪問瀏覽器 http://localhost:6060/

訪問指定的包
http://localhost:6060/pkg/fmt/
http://localhost:6060/pkg/archive/tar/

可以通過godoc -url "http://localhost:6060/pkg/" > doc.html導(dǎo)出為靜態(tài)的html單個(gè)文件,但是這個(gè)體驗(yàn)很差。

如果我們要查看一個(gè)第三方包的文檔,比如 github.com/julienschmidt/httprouter
首先要進(jìn)入它的源碼目錄
godoc -http=localhost:6060
第一部分依然是 Go Standard library,第二部分 Third party 才是 httprouter 的文檔

如果我們要查看某個(gè)項(xiàng)目的文檔也可以使用這種方式,然后我就發(fā)現(xiàn)我們自己寫的項(xiàng)目大多沒有什么注釋,于是這就牽涉到注釋的規(guī)范。

注釋使用//加一個(gè)空格并且要緊跟著被注釋對(duì)象的上方。

首先需要給package加上注釋,說明此包的作用,例如

// Package bufio implements buffered I/O. It wraps an io.Reader or io.Writer
// object, creating another object (Reader or Writer) that also implements
// the interface but provides buffering and some help for textual I/O.
package bufio

同一目錄下的包可以由很多個(gè)文件組成,如果每個(gè)文件都有對(duì)package進(jìn)行注釋的話,godoc會(huì)自動(dòng)將所有注釋"按照文件名的字母數(shù)序"進(jìn)行合并

在無效注釋中以BUG(who)開頭的注釋, 將被識(shí)別為已知bug, 顯示在bugs區(qū)域

  // BUG(who): 因?yàn)榍懊嬗蠦UG(who)這個(gè)關(guān)鍵字,所以這句注釋就算沒有緊跟關(guān)鍵字不會(huì)被隱藏掉

關(guān)于DEPRECATED棄用

// Time returns an int64 unix timestamp in milliseconds of the snowflake ID time
// DEPRECATED: the below function will be removed in a future release.
func (f ID) Time() int64 {
	return (int64(f) >> timeShift) + Epoch
}

在注釋符要縮進(jìn)的話,第二行注釋符后面的空格要比上一行的空格多一個(gè)

  example:
      // 123
      //  123

關(guān)于 go doc xxx
主要用來在終端上查看某個(gè)包的文檔,它也是通過掃描包內(nèi)的一些注釋,然后格式化輸出,但很少這么用。

> go doc fmt

package fmt // import "fmt"
Package fmt implements formatted I/O with functions analogous to C's printf
and scanf. The format 'verbs' are derived from C's but are simpler.
Printing
The verbs:
General:

    %v  the value in a default format
        when printing structs, the plus flag (%+v) adds field names
    %#v a Go-syntax representation of the value
    %T  a Go-syntax representation of the type of the value
    %%  a literal percent sign; consumes no value
...
...

go doc約定規(guī)則

godoc
Go的注釋規(guī)則很簡(jiǎn)單,為類型,變量,常量,函數(shù)或包編寫注釋時(shí),直接在這些聲明前編寫普通形式的注釋,中間不留空行即可。Godoc將這些注釋與后面的聲明連接到一起,達(dá)到文檔化的目的。

1.注釋符// 后加空格

// 這是一行注釋
package main

2.注釋緊鄰關(guān)鍵字行寫,否則不會(huì)被識(shí)別

// 不會(huì)被識(shí)別
// 會(huì)被識(shí)別
package main
// 不會(huì)被識(shí)別
 
// 會(huì)被識(shí)別1
// 會(huì)被識(shí)別2
func main(){
}

3.注釋行的數(shù)量最好不要超過3行

4.已知bug注釋:BUG(who)
godoc的輸出將忽略那些與頂層聲明不相鄰的注釋,只有一個(gè)例外,那就是以BUG(who)開頭的注釋。這些注釋將被識(shí)別為已知的bug,并包含在文檔的BUGS區(qū)。

// 注釋
package main
// BUG(who)  //會(huì)被識(shí)別,放入文檔的Bugs區(qū)
const a = 8

使用命令

首先在命令行進(jìn)入所需要執(zhí)行的.go文檔目錄
例:我的test.go放在C:/GoProject/src/test/ 目錄下
需要在命令行進(jìn)入C:/GoProject/src/test/
然后執(zhí)行命令

godoc -http=:6060 ? ? //6060是godoc提供的默認(rèn)端口

在瀏覽器輸入 localhost:6060,即可進(jìn)入godoc的網(wǎng)站,查看自己的文檔需要在地址欄輸入路徑 localhost:6060/pkg/test

到此這篇關(guān)于Golang中的godoc使用簡(jiǎn)介的文章就介紹到這了,更多相關(guān)go語言godoc使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • Go語言為什么不支持三元運(yùn)算符原理解析

    Go語言為什么不支持三元運(yùn)算符原理解析

    這篇文章主要為大家介紹了Go語言為什么不支持三元運(yùn)算符原理解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪
    2023-08-08
  • 一文帶你搞懂Golang結(jié)構(gòu)體內(nèi)存布局

    一文帶你搞懂Golang結(jié)構(gòu)體內(nèi)存布局

    結(jié)構(gòu)體在Go語言中是一個(gè)很重要的部分,在項(xiàng)目中會(huì)經(jīng)常用到。這篇文章主要帶大家看一下結(jié)構(gòu)體在內(nèi)存中是怎么分布的?通過對(duì)內(nèi)存布局的了解,可以幫助我們寫出更優(yōu)質(zhì)的代碼。感興趣的小伙伴們可以參考借鑒,希望對(duì)大家能有所幫助
    2022-10-10
  • Go語言使用singleflight解決緩存擊穿

    Go語言使用singleflight解決緩存擊穿

    在構(gòu)建高性能的服務(wù)時(shí),緩存是優(yōu)化數(shù)據(jù)庫(kù)壓力和提高響應(yīng)速度的關(guān)鍵技術(shù),但使用緩存也會(huì)帶來一些問題,其中就包括緩存擊穿,下面我們就來看看Go語言中如何使用singleflight解決緩存擊穿問題吧
    2024-03-03
  • Go語言基礎(chǔ)函數(shù)基本用法及示例詳解

    Go語言基礎(chǔ)函數(shù)基本用法及示例詳解

    這篇文章主要為大家介紹了Go語言基礎(chǔ)函數(shù)基本用法及示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步早日升職加薪
    2021-11-11
  • 深入解析Go語言中crypto/subtle加密庫(kù)

    深入解析Go語言中crypto/subtle加密庫(kù)

    本文主要介紹了深入解析Go語言中crypto/subtle加密庫(kù),詳細(xì)介紹crypto/subtle加密庫(kù)主要函數(shù)的用途、工作原理及實(shí)際應(yīng)用,具有一定的參考價(jià)值,感興趣的可以了解一下
    2024-02-02
  • Go語言中的函數(shù)式編程實(shí)踐

    Go語言中的函數(shù)式編程實(shí)踐

    這篇文章主要介紹了Go語言中的函數(shù)式編程實(shí)踐,主要講解Go語言中的函數(shù)式編程概念和使用。小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2018-05-05
  • 一文教你打造一個(gè)簡(jiǎn)易的Golang日志庫(kù)

    一文教你打造一個(gè)簡(jiǎn)易的Golang日志庫(kù)

    這篇文章主要為大家詳細(xì)介紹了如何使用不超過130行的代碼,通過一系列g(shù)olang的特性,來打造一個(gè)簡(jiǎn)易的golang日志庫(kù),感興趣的小伙伴可以了解一下
    2023-06-06
  • 利用golang進(jìn)行OpenCV學(xué)習(xí)和開發(fā)的步驟

    利用golang進(jìn)行OpenCV學(xué)習(xí)和開發(fā)的步驟

    目前,OpenCV逐步成為一個(gè)通用的基礎(chǔ)研究和產(chǎn)品開發(fā)平臺(tái),下面這篇文章主要給大家介紹了關(guān)于利用golang進(jìn)行OpenCV學(xué)習(xí)和開發(fā)的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),需要的朋友可以參考下
    2018-09-09
  • 詳解Go中處理時(shí)間數(shù)據(jù)的方法

    詳解Go中處理時(shí)間數(shù)據(jù)的方法

    在許多場(chǎng)合,你將不得不編寫必須處理時(shí)間的代碼。在Go中處理時(shí)間數(shù)據(jù)需要你從Go標(biāo)準(zhǔn)庫(kù)中導(dǎo)入?time?包。這個(gè)包有很多方法和類型供你使用,但我選取了最常用的方法和類型,并在這篇文章中進(jìn)行了描述,感興趣的可以了解一下
    2023-04-04
  • 詳解golang中的method

    詳解golang中的method

    這篇文章主要介紹了golang中的method的相關(guān)資料,幫助大家更好的理解和使用golang,感興趣的朋友可以了解下
    2021-01-01

最新評(píng)論