문서화 썸네일형 리스트형 자체 문서화 코드 들어가기 개발하다 보면 코드에 주석을 달라는 말을 많이 듣는다. 이 말은 대부분의 코드는 이해 힘들기 때문에 코드에 대한 주석을 추가해서 코드 이해를 하기 쉽게 하기 위한 목적이다. 이 글은 코드를 이해하기 위한 시작에 대한 이야기이다. CodeCraft에서 재미난 주제로 다룬 내용이 있어서 여러 분과 공유하고 싶어서 정리해보았다. 작성자: ospace114@empal.com, http://ospace.tistory.com/ 코드에 주석 달기 코드에 주석 달기는 매우 흔하게 하는 작업이다. 개발하는 과정에서 설계나 별도 문서가 잘 작성되어 있어서 주석이 필요없을지도 모른다. 그렇지만 현실에서는 그런 문서가 없을 가능성이 매우 높다. 또한 있다고 해서 거의 쓸모 없는 경우가 많고 코드가 오랜동안 유지보수된.. 더보기 코드 문서화 작성: http://ospace.tistory.com/,2011.01.07 (ospace114@empal.com) 아래 내용은 예전에 작성한 내용이다. 다시 조만간 정리해야할 것 같다. Doxygen도 사용하기 조금 복잡한 형태이다. 다른 표기형태도 고려가 필요하다. Doxygen 헤더파일 주요 설명 /* \헤더파일 대표 이름 !헤드라인 주요설명 -.\ \n -.\ \n */ 클래스나 구조체 설명 /** 타이틀 설명 \auth 작성자 \todo 해야할일 */ 함수 설명 //! 타이틀 및 간력 설명 //! 추가설명 //! \return 리턴값 int func (int n1, ///< 인자1 설명 int n2, ///< 인자2 설명 ) { int num; ///< 변수명 } 기타 /** 여러줄 설명 */ /.. 더보기 이전 1 다음
