이전에 C 스타일의 코드에 대한 문서를 작성한 적은 한 번도 없었습니다 (asdoc 및 phpdoc 만 수행). 나는 Objective-C 코드를 문서화하기 위해 Doxygen을보고 있었지만 코멘트를 어디에 둘 것인지 확실치 않습니다. .h 파일을 문서화해야합니까, 아니면 .m 파일에 주석을 추가해야합니까? 아니면 둘다? 다른 추천 사항이 있습니까?Doxygen을 사용하여 코드를 문서화하는 곳
와 Doxygen을 사용하는 방법에 대한보다 깊이있는 예이다, 의견은 대부분 선언하고이 포함되어 있기 때문에, 헤더 파일 (* .H)에 배치 할 수 있습니다 읽을 수 있습니다.
소스 파일 (* .m)에 대한 문서는 관련 헤더 파일이없는 경우에 유용합니다 (예 : 클래스에 개인 범주를 사용하는 경우).
또한 Doxygen에는 몇 가지 사항이 문서화되지 않았거나 충분하지 않은 경우 몇 가지 경고를 표시하는 옵션이 있습니다.
편집 :
여기 Documenting Objective-C with Doxygen라는 튜토리얼에 대한 링크입니다.
일부 프로젝트의 doxygen 문서를보고 그들이하는 일을 확인하십시오.
http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/은 나를 감동시킨 사람이지만, 훌륭한 직업을 가진 객관적인 -c 프로젝트를 찾을 수있을 것이라고 확신합니다.
API 문서는 .h 파일로 저장됩니다. 문서화할만한 구현 세부 사항이있을 수 있으므로 .m 파일에도 일부 내용이 포함될 것입니다. 그냥 반복하지 마십시오.
코드가 이미 말하는 것을 반복하지 마십시오.
귀하의 의견은 일반적으로 .h 파일에 속합니다. 사람들이 귀하의 수업 사용법을 파악하기 위해 사용하는 것입니다.
Here이 대회 구체적으로 목표 C