맛보기

DOC++을 바로 써보고 싶다면, 다음 줄을

/// ...

각 함수, 변수, 클래스, define 등의 여러분이 문서화 하려는 곳앞에 추가한다. ``...''에는 시작되는 문서화 문자열을 선택할 수 있다. 일반적으로는 헤더 파일에서만 적용하고자 할 것이다. 여러 줄로 쓰고 싶다면 다음과 같이 쓴다.

/**
...
*/

그리고 ``...'' 자리에 문서화할 문구를 써준다. 이 주석을 포함한 소스 파일은 docified되었다고 부른다. 다음과 같이 명령을 내린다

> docify <original> <docfile>

이 명령은 쉘에서 <original> 파일에서 <docfile>을 생성한다. >은 쉘 프롬프트이므로 입력하지 않는다.

이제 다음과 같이 입력하여 DOC++을 실행한다:

> doc++ -d html <files>

위는 HTML 출력을 얻고자 하는 경우이며

> doc++ -t -o doc.tex <files>

위는 LaTeX 출력을 얻는 경우이다, where <files> 에는 docified 파일 리스트가 온다.

각 `///' 주석은 한줄짜리 메뉴얼 엔트리가 된다. 메뉴얼 엔트리를 그룹화할 필요가 있다면, 다음의 구조를 따르면 된다

/**@name <name for the group>
* <documentation for the group>
*/
//@{
<other manual entries>
//@}

이는 특정한 이름의 엔트리를 생성할 것인데, 그 엔트리에는 모든 <other manual entries>를 부엔트리로 둔다. 클래스 멤버는 자동으로 클래스의 메뉴얼 엔트리에서 부엔트리로 지정된다는 것을 기억해야 한다. 또한 다음과 같은 주석으로 다른 파일을 포함할 수도 있다

//@Include: <file(s)>

Alphabetic index Hierarchy of classes



This page was generated with the help of DOC++.