인라인 문서 추가하기

ProgrammingCeylon
Ceylon, Documentation, Programming

대부분의 경우 hello() 와 같은 중요한 함수에 어떤 종류의 문서를 추가하는 것은 좋은 생각이다. 한가지 방법은 다음과 같이 C 스타일의 주석을 사용하는 것이다.

1
2
3
4
/* The classic Hello World program */
void hello() {
    print("Hello, World!");
}

또는

1
2
3
4
//The classic Hello World program
void hello() {
    print("Hello, World!");
}

그러나 정의를 기술하기 위한 주석으로 doc 어노테이션을 사용하는 것이 더 낫다.

1
2
3
4
5
6
7
doc ("The classic Hello World program")
by ("Gavin")
see (goodbye)
throws (IOException)
void hello() {
    print("Hello, World!");
}

doc, by, see, throws, tagged 어노테이션은 Ceylon 문서화 컴파일러인 ceylon doc 의 출력에 포함될 내용을 가진다.

doc, by, see, throws 와 같은 어노테이션은 키워드가 아니다. 그냥 평범한 식별자이다. abstract, variable, shared, formal, default, actual 등의 언어 정의의 한 부분인 어노테이션들도 마찬가지다.(반면에, void 는 C 나 Java 처럼 키워드이다.)

doc 어노테이션은 어디에나 존재할 수 있기 때문에, 프로그램 요소의 어노테이션 목록에서 첫번째 어노테이션에 위치하면 이름과 괄호를 생략할 수 있다

1
2
3
4
5
6
7
"The classic Hello World program"
by ("Gavin")
see (goodbye)
throws (IOException)
void hello() {
    print("Hello, World!");
}
Share Comments