코드 파일 외부의 코드 문서

몇 가지 이유로 API를 문서화하고 싶지만 현재 널리 사용되는 소스 코드에 직접 문서를 작성하고 싶지는 않습니다. 설명서 파일을 입력으로 취할 수있는 문서 생성기 도구를 찾고 있는데, 소스 코드에서 함수 원형을 가져 와서 문서의 일관성을 검사 할 수 있어야합니다. 그 일을 할 수있는 도구를 아십니까?코드 파일 외부의 코드 문서

출처

2013-08-17 Valentin Perrelle

작성된 코드는 어떤 언어입니까? 그것은 매우 관련성이있을 수 있습니다. 질문에 태그를 달아야합니다. –

지금은 C++. 어쨌든 다른 언어에 대해서도 이런 종류의 도구가 필요할 수 있으므로 좀 더 일반적인 대답을 갖고 싶습니다. –

소스 파일이 소스 파일에서 "떨어져"유지되면 소스가 업데이트 될 때 업데이트 될 가능성이 적습니다 (코드와 주석이 같은 파일에있을 때 코드와 주석이 동기화되지 않는 빈도를 알면). 그건 좋은 계획이 아니라고. –

Doxygen은 문서 텍스트가 원본 외부에있을 때 코드를 문서화 할 수 있습니다. 당신이

SOURCE.H

void func();

이

당신이

소스를 추가 할 수있는 경우, 예를 들어

: 그냥 헤더를 포함, 그 텍스트 주석이있는 souce에 파일을 생성 .DOX

/** 
    \function void func() 
    Your usual doxygen text here. 
*/

그리고 .h 및 .dox 파일을 모두 허용하는 doxygen을 만드는 설명서를 생성하십시오.

출처

2013-08-17 17:01:03

나는 소스 코드에 그것을 쓰지 않는 것이 좋을 것이라는 이전 의견에 동의한다. 저자가 자신의 사고 방식을 바꾸도록 설득해야한다고 생각합니다. :) – lpapp

@Laszlo Papp : "의견을 어디에 써야하는지"에 대한 토론이 아닙니다. Stackoverflow는 Q & A 형식에 더 적합합니다. –

@ Emilio Garavaglia :이 대답에 감사드립니다. –

코드 파일 외부의 코드 문서

답변

관련 문제