golang에서는 godoc 도구를 사용하여 댓글 내용을 추출할 수 있습니다. godoc 도구는 Go 프로그램 및 패키지 파일에서 최상위 선언의 첫 번째 줄 주석과 각 개체의 관련 주석을 추출하고 관련 문서를 생성할 수도 있습니다.
이 튜토리얼의 운영 환경: Windows 10 시스템, GO 버전 1.18, Dell G3 컴퓨터.
golang에서는 godoc 도구를 사용하여 댓글 내용을 추출할 수 있습니다.
godoc 도구
godoc 도구는 Go 프로그램 및 패키지 파일에서 최상위 선언의 첫 번째 줄 주석과 각 개체의 관련 주석을 추출하고 관련 문서를 생성하는 웹으로도 사용할 수 있습니다. 온라인 문서 열람을 제공합니다. 서버인 Go 언어 공식 홈페이지(https://golang.google.cn/)가 이런 형태로 구현되어 있습니다.
참고: godoc 도구는 Go 언어 버전 1.13에서 제거되었습니다. go get
명령을 통해 godoc 도구를 얻을 수 있습니다. go get
命令来获取 godoc 工具。
go get golang.org/x/tools/cmd/godoc
由于防火墙的原因,国内的用户可能无法通过go get 命令来获取 godoc 工具,这时候就需要大家来手动操作了。
首先从 GitHub(https://github.com/golang/tools.git) 下载 golang.org/x/tools 包;
然后将下载得到的文件解压到 GOPATH 下的 srcgolang.orgxtools 目录中,没有的话可以手动创建;
打开 GOPATH 下的 srcgolang.orgxtoolscmdgodoc 目录,在该目录下打开命令行工具,并执行go build 命令,生成 godoc.exe 可执行文件;
最后,将生成的 godoc.exe 文件移动到 GOPATH 下的 bin 目录中。(需要把 GOPATH 下的 bin 目录添加到环境变量 Path 中)
完成上述操作后就可以使用 godoc 工具了,godoc 工具一般有以下几种用法:
go doc package
:获取包的文档注释,例如go doc fmt
会显示使用 godoc 生成的 fmt 包的文档注释;
go doc package/subpackage
:获取子包的文档注释,例如go doc container/list
;
go doc package function
:获取某个函数在某个包中的文档注释,例如go doc fmt Printf
会显示有关 fmt.Printf()
的使用说明。
godoc 工具还可以获取 Go 安装目录下 ../go/src 中的注释内容,并将这些注释内容整合到 web 服务器中供我们预览。在命令行输入godoc -http=:6060,然后使用浏览器打开 http://localhost:6060 后,就可以看到本地文档浏览服务器提供的页面。
godoc的使用
在终端查看
在终端,进入要查看的包的目录go doc
显示当前包的文档
这里查看的是包名的文档,以及所有的函数名字跟变量类型名
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)命名
go doc <pkg>.<func>
查看pkg包下面的func函数的注释
example: go doc test.Test terminal show: package test // import "test/testdoc" func Test(param1 string, inter int) (k string) 功能: 测试函数 参 数: param1 : 说明参数值 inter : 运算的数字 返回值: k : 返回值
如果想查看完整的源码go doc -src <pkg>.<func>
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 }
在浏览器上查看
使用命令godoc -http=:6060
然后在打开浏览器的,在url输入localhost:6060/pkg
或者127.0.0.1:6060/pkg
就可以查看到你本地的所有包的信息了
如果你想要找到你特定的包名的话localhost:6060/pkg/<path>/<packagename></packagename></path>
或者127.0.0.1:6060/pkg/<path>/<packagename></packagename></path>
<path></path>
是你/src下包所在的路径
<packagename></packagename>
是包名
导出godoc文档为HTML
使用命令godoc -url "http://localhost:6060/pkg/<pkg>/<packagename>/" > <packagename>.html</packagename></packagename></pkg>
<pkg></pkg>
是你包所在的文件夹
<packagename></packagename>
rrreee
GOPATH 아래의 srcgolang.orgxtoolscmdgodoc 디렉터리를 열고 명령줄을 엽니다. 이 디렉터리에 있는 도구를 실행하고 go build 명령을 실행하여 godoc.exe 실행 파일을 생성합니다.
🎜🎜🎜위 작업을 완료한 후 godoc 도구를 사용할 수 있습니다. godoc 도구는 일반적으로 다음과 같은 용도로 사용됩니다. : 🎜
go doc package
: 패키지의 문서 주석을 가져옵니다(예: go doc fmt는 생성된 fmt 패키지의 godoc 문서 주석을 사용하여 표시합니다. 🎜🎜<li>🎜<code>go doc package/subpackage
: go doc 컨테이너와 같은 하위 패키지의 문서 주석을 가져옵니다. /list
; 🎜🎜 go doc 패키지 함수
: 패키지에 있는 함수의 문서 주석을 가져옵니다(예: go doc fmt Printf
) fmt.Printf ()
사용 지침에 대한 관련 정보를 표시합니다. 🎜🎜🎜🎜 godoc 도구는 Go 설치 디렉터리의 ../go/src에서 주석 콘텐츠를 얻을 수도 있고 이러한 주석 콘텐츠를 웹 서버에 통합하여 미리 볼 수도 있습니다. 명령줄에 godoc -http=:6060을 입력한 후 브라우저를 사용하여 http://localhost:6060을 열면 로컬 문서 검색 서버에서 제공하는 페이지를 볼 수 있습니다. 🎜🎜🎜🎜🎜godoc 사용🎜🎜🎜🎜🎜터미널에서 보기🎜🎜🎜터미널에서 보려는 패키지 디렉토리를 입력 go doc
현재 패키지 문서를 표시합니다 🎜🎜 여기서 보는 것은 패키지 이름과 모든 함수 이름, 변수 유형 이름이 포함된 문서입니다 🎜rrreee🎜go doc <pkg>.<func> code> pkg 패키지 아래 func 함수 보기 참고 🎜rrreee🎜전체 소스 코드를 보려면
go doc -src <pkg>.<func>
🎜rrreee🎜🎜에서 보기 브라우저🎜🎜🎜godoc -http =:6060
🎜🎜명령을 사용하세요. 그런 다음 브라우저를 열고 localhost:6060/pkg
또는 127.0.0.1:6060을 입력하세요. 모든 로컬 패키지에 대한 정보🎜🎜특정 패키지 이름을 찾으려면
localhost:6060/pkg/
127.0.0.1 :6060/pkg/
🎜
<path></path>
예 /src🎜🎜<packagename></packagename>
아래의 패키지 경로는 패키지 이름입니다🎜🎜🎜🎜🎜godoc 문서를 HTML로 내보내기 🎜🎜🎜 godoc -url " http://localhost:6060/pkg/<pkg>/<packagename>/" > <packagename>.html</packagename></packagename></pkg>
🎜🎜
<pkg></pkg>
는 패키지가 있는 폴더입니다🎜🎜<packagename> code> 는 내보낸 패키지 이름입니다🎜🎜🎜🎜 스타일시트가 없는 순수 html 파일인데 내보낼 수도 있지만 아직까지 못찾은 친구가 있다면 하면 됩니다. 공유해주세요🎜🎜하지만 해당 스타일 파일도 내보냈습니다🎜🎜다운로드 주소 https: //github.com/BaiYu96/golandLearn/tree/master/learn_doc/stylefile🎜<p>그런 다음 HTML 파일에서 CSS 및 js로 지정된 경로를 수정하세요</p><p>[관련 권장 사항: <a href="http://www.php.cn/course/list/44.html" target="_blank">Go 비디오 튜토리얼</a>, <a href="https://www.php.cn/course.html" target="_blank" textvalue="编程教学">프로그래밍 교육</a>]</p></packagename>
위 내용은 golang에서 댓글 내용을 얻는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!