ANSIC에서 설명서 코멘트를 작성하는 방법은?
C에서 댓글을 쓰는 방법을 찾을 수가 없습니다.내 말은 내가 알고 있다는 뜻입니다.//그리고./* */, 제 말은 어디서 좋은 관행을 찾을 수 있을까요?만약 함수가 있다면 어떻게 쓰나요?@param variable is the value bla bla, 자바에서 하는 것처럼?
이것에 대한 기준이 있습니까?아니면 자바로 하는 것처럼 하면 되나요?
다양한 표준이 있으며 문서화를 생성하려면 doxygen을 사용해 보십시오.
javadoc 표준을 사용한 다음 javadoc을 이해하는 doxygen을 사용하여 문서를 생성할 수 있습니다.
doxygen에서는 옵션을 사용하는 것을 추천합니다.JAVADOC_AUTOBRIEF로 설정.YES. JAVADOC_AUTOBRIEF 태그가 YES로 설정된 경우 doxygen은 JavaDoc 스타일 주석의 첫 번째 줄(첫 번째 점까지)을 간단한 설명으로 해석합니다.
클래스 정의의 예:
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
(독산소 설명서의 몇 가지 예시)
설치는 매우 간단하며 GUI와 다음과 같은 그래픽 시각화 기능이 있습니다.
apt-get install doxygen doxygen-gui graphviz
gui 호출 실행doxywizard마법사 설정만 사용합니다.JAVADOC_AUTOBRIEF"Expert" 설정에서 설정해야 합니다.
귀사에서 요구하는 기준을 따르는 기준은 없습니다.
프로젝트에서 문서를 만드는 일반적인 방법은 doxygen을 사용하는 것입니다.
주석을 작성하는 doxygen 형식을 사용하는 것이 옵션입니다. 이는 코드에 대해 html/latex 및 기타 종류의 문서를 생성할 수 있는 추가적인 이점이 있습니다.
언급URL : https://stackoverflow.com/questions/8889942/how-to-write-documentation-comments-in-ansi-c
'programing' 카테고리의 다른 글
| 수학의 함수와 프로그래밍의 함수는 어떤 차이가 있습니까? (0) | 2023.09.25 |
|---|---|
| VC++ 명령줄을 사용하여 .dll 및 .lib 파일 생성 (0) | 2023.09.25 |
| WordPress TemplatePath (0) | 2023.09.25 |
| realoc 및 memcpy는 어떻게 작동합니까? (0) | 2023.09.25 |
| angularjsng-disabled가 버튼에 비활성화를 추가하지 않음 (0) | 2023.09.25 |