[Go] godoc 올리기

#Go

godoc은 go에서 제공하는 문서화 도구다.
export된 함수와 주석을 기반으로 문서를 자동 생성해준다.

설치

먼저 cli 도구와 최신 종속성을 깔아준다.
get도 해줘야 go mod 기반의 생성이 가능하다.

go install -v golang.org/x/tools/cmd/godoc@latest
go get -u golang.org/x/tools/cmd/godoc

cli를 실행하면 바로 문서를 띄울 수 있다.

godoc -http=:6060

그러면 이렇게 페이지가 뜨는데, 내장모듈이나 추가로 깔려있는 모듈 이것저것이 다 뜨는듯하다.
내가 볼건 jsun이다.

보고싶은 패키지로 이동하면

이런식으로 뜬다.

go 패키지들은 기본적으로, 수동 배포가 없다.
그냥 적절히 태그 따서 배포해두면

알아서 페이지를 생성해주는 식이다.
구글이라서 가능한건가...

좀 기다리면 이런식으로 페이지를 자동 생성해준다.
URL은 pkg.go.dev/github.com/유저네임/레포지토리 의 형태를 가진다.

만약, 올려놨는데도 바로 반영이 안된다면, godoc 페이지에서 재촉을 할 수도 있다.

저기서 리퀘스트 누르면 된다.