Bagaimana untuk mendapatkan kandungan komen dalam golang

Dalam golang, anda boleh menggunakan alat godoc untuk mengekstrak kandungan ulasan. Alat godoc mengekstrak komen baris pertama bagi pengisytiharan peringkat atas dan ulasan berkaitan setiap objek daripada program Go dan fail pakej, dan menjana dokumen berkaitan Ia juga boleh berfungsi sebagai pelayan web yang menyediakan penyemakan imbas dokumen dalam talian.

Persekitaran pengendalian tutorial ini: sistem Windows 10, GO versi 1.18, komputer Dell G3.

Dalam golang, anda boleh menggunakan alat godoc untuk mengekstrak kandungan ulasan.

alat godoc

alat godoc mengekstrak komen baris pertama pengisytiharan peringkat atas dan ulasan berkaitan setiap objek daripada program Go dan fail pakej , dan menjana dokumen yang berkaitan, dan juga boleh digunakan sebagai pelayan web yang menyediakan penyemakan imbas dokumen dalam talian Laman web rasmi bahasa Go (https://golang.google.cn/) dilaksanakan dalam borang ini.

Nota: Alat godoc telah dialih keluar daripada bahasa Go versi 1.13 Anda boleh mendapatkan alat godoc melalui perintah go get.

go get golang.org/x/tools/cmd/godoc

Disebabkan tembok api, pengguna domestik mungkin tidak dapat mendapatkan alat godoc melalui arahan go get Pada masa ini, semua orang perlu mengendalikannya secara manual.

• Muat turun pakej golang.org/x/tools daripada GitHub (https://github.com/golang/tools.git)

• Kemudian nyahzip fail yang dimuat turun ke dalam direktori srcgolang.orgxtools di bawah GOPATH Jika ia tidak wujud, anda boleh menciptanya secara manual; dan dalam direktori ini Buka alat baris arahan dan laksanakan arahan go build untuk menjana fail boleh laku godoc.exe

• Akhir sekali, alihkan fail godoc.exe yang dihasilkan ke direktori bin di bawah; GOPATH. (Anda perlu menambah direktori bin di bawah GOPATH kepada Laluan pembolehubah persekitaran)

Selepas menyelesaikan operasi di atas, anda boleh menggunakan alat godoc. Alat godoc secara amnya Terdapat beberapa kegunaan:

: Dapatkan ulasan dokumentasi pakej, contohnya,

akan memaparkan ulasan dokumentasi pakej fmt yang dihasilkan menggunakan godoc;

• go doc packagego doc fmt

  : Dapatkan ulasan dokumentasi sub-pakej, seperti
; : Dapatkan ulasan dokumentasi fungsi dalam pakej tertentu, contohnya
• akan memaparkan arahan untuk menggunakan

  . go doc package/subpackagego doc container/list

Alat godoc juga boleh mendapatkan kandungan anotasi dalam ../go/src dalam direktori pemasangan Go dan menyepadukan kandungan anotasi ini ke dalam pelayan web untuk kami pratonton. Masukkan godoc -http=:6060 pada baris arahan, dan kemudian gunakan penyemak imbas untuk membuka http://localhost:6060 Anda boleh melihat halaman yang disediakan oleh pelayan penyemakan imbas dokumen tempatan.

• go doc package functiongo doc fmt Printffmt.Printf()

Penggunaan godoc

Lihat dalam terminal

Dalam terminal, masukkan direktori pakej yang anda mahu lihatPaparkan dokumen pakej semasaApa yang anda lihat di sini ialah dokumen nama pakej, serta semua nama fungsi dan nama jenis pembolehubah

Lihat ulasan fungsi func di bawah pakej pkg

go docJika anda ingin melihat kod sumber lengkap

example:
    go doc
    
terminal show:
    package test // import "test/testdoc"
    这个是a.go的包名的描述


    At 20191017 by Baiyu
    
    ---a.go end---
    
    这个是在doc.go 文件中的内容
    
    在Go的源代码中
    
    在Mac系统中
    
    在类Unix系统中
    
    在Windows系统中
    
    ---doc.go end---
    
    这个是在testgodoc.go文件的内容 package Name: test
    
        describe:    程序的入口
    
    ---testgodoc.go end---
    
    这个是z.go 的包名描述
    
    ---z.go end---
    
    const Email ...
    const Baiyu = "baiyu"
    func H(h1 string, h2 string) (reValue string)
    func Test(param1 string, inter int) (k string)
    func Z()
    type Computer struct{ ... }
    type Person struct{ ... }
    
    BUG: 这个注释会生成在文档最后后面，同时因为紧跟着fun Z，所以在上面的func列表里面也有显示
    功能: 生成Z签名
    
    BUG: 因为前面有BUG(who)这个关键字，所以这句注释就算没有紧跟关键字不会被隐藏掉
    
    BUG: BUG(6):格式正确，所以这句注释就算没有紧跟关键字不会被隐藏掉，前面的BUG():、BUG6:、BUG:都是不正确的BUG(who)命名

Lihatnya pada penyemak imbasgo doc <pkg>.<func></func></pkg>

example:
    go doc test.Test
    
terminal show:
     package test // import "test/testdoc"
     func Test(param1 string, inter int) (k string)
        功能: 测试函数
   
        参  数:
            param1  : 说明参数值
            inter   : 运算的数字
        返回值:
            k       : 返回值

Gunakan arahan

go doc -src <pkg>.<func></func></pkg>

dan kemudian buka penyemak imbas dan masukkan

example: 
    go doc -src test.Test 
    
terminal show:
    package test // import "test/testdoc"
    // 功能: 测试函数
    //  参  数:
    //      param1  : 说明参数值
    //      inter   : 运算的数字
    //  返回值:
    //      k       : 返回值
    func Test(param1 string, inter int) (k string) {
            fmt.Println("测试函数")
            return param1
    }

atau

dalam url untuk melihat maklumat semua pakej tempatan anda Jika anda ingin mencari nama pakej khusus anda

atau

godoc -http=:6060

localhost:6060/pkg127.0.0.1:6060/pkg ialah laluan di mana pakej terletak di bawah /src anda

localhost:6060/pkg/<path>/<packagename></packagename></path>127.0.0.1:6060/pkg/<path>/<packagename></packagename></path>

ialah nama pakej

• <path></path>

  Eksport dokumen godoc sebagai HTML

• Gunakan arahan <packagename></packagename>

ialah folder di mana pakej anda terletak

godoc -url "http://localhost:6060/pkg/<pkg>/<packagename>/" > <packagename>.html</packagename></packagename></pkg>

ialah nama pakej anda

• <pkg></pkg>Fail yang dieksport ialah fail html tulen tanpa helaian gaya Walau bagaimanapun, adalah mungkin untuk mengeksportnya, tetapi saya belum menemuinya lagi. Jika anda mempunyai rakan yang telah menemuinya, anda juga boleh berkongsinya

Tetapi saya juga memberikan fail gaya yang sepadan

• Alamat muat turun https://github.com/BaiYu96/golandLearn/. tree/master/learn_doc/stylefile<packagename></packagename>

  Kemudian hanya ubah suai laluan yang ditentukan oleh css dan js dalam fail html

  [Cadangan berkaitan: Pergi tutorial video, Pengajaran pengaturcaraan]

Atas ialah kandungan terperinci Bagaimana untuk mendapatkan kandungan komen dalam golang. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!