godoc

 

godoc

 

godoc이란?

godoc은 go 프로그램의 문서를 생성하게 해줌.

 

[godoc 링크]

https://pkg.go.dev/golang.org/x/tools/cmd/godoc

 

 

godoc 설치

 

 [설치 명령어]

 

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

 

godoc 문서 생성

 

아래 명령어를 사용하면 작성한 코드와 사용하고 있는 package를 가지고 문서를 만들어줌.

그리고 문서를 볼 수 있는 local server를 제공함.

해당 문서를 통해 작성한 프로그램에서 사용한 다양한 golang package의 docs를 

오프라인으로 확인할 수 있음.

 

[명령어]

godoc -http=:6060

포트는 변경해도 됨.

[결과 확인]

localhost:6060으로 접속하면

documentation을 확인 할 수 있고

모든 표준 library들의 package를 볼 수 있음.

 

표준 library이외에도 본인이 작성한 golang package에 대한 설명도 볼 수 있음.

ex)

 

작성한 package에 대해 문서를 작성할 수 있음.

 

godoc package 문서 작성

 

문서 작성 시 golang docs를 살펴보면 문서의 규칙같은 것이 있으니

참고해서 작성해주면 좋음.

 

Synopsis, Overview 작성

package의 go파일 최상단에 

주석을 작성해놓으면

godoc package 문서의 Synopsis 항목에서 확인할 수 있음.

해당 package를 클릭해보면

Overview에서도 해당 주석을 그대로 확인 할 수 있음.

 

함수 comment 작성

작성한 함수 상단에 

주석을 작성 해놓으면

주석은 여러줄로 달 수 있음. 

여러 줄로 작성해도 모두 comment로 확인 가능