Go ) 문서화하기

Go 언어는 패키지를 만들면서 문서화도 할 수 있다. 다음과 같이 calc 패키지의 Sum 함수에 대한 설명을 작성한다.

// 계산 패키지
package calc
 
// 두 정수를 더함
func Sum(a int, b int) int {
    return a + b
}

package 키워드와 함수 정의 바로 위에 // 주석 형태로 함수 설명을 작성한다. // 주석을 여러 줄로 작성해도 된다.

 

다음과 같이 GOPATH 디렉터리에서 godoc 명령을 실행해 패키지 및 함수 정보를 출력할 수 있다.

~GOPATH$ godoc calc
PACKAGE    DOCUMENTATION
 
package calc
    import "calc"
 
    계산 패키지
 
FUNCTIONS
 
func Sum(a int, b int) int
    두 정수를 더함

godoc <패키지 이름> 형식이다. 이렇게 실행하면 소스 코드에 주석 형태로 작성한 설명이 코드와 함께 정리되어 표시된다.

 

다음과 같이 godoc <패키지 이름><함수 이름> 형식으로 특정 함수의 정보를 출력할 수도 있다.

$ godoc calc Sum
func Sum(a int, b int) int
    두 정수를 더함