and so on

개발 문서화 방법

밀크빵 2014. 3. 11. 19:14

소스코드에 주석으로 개발 문서 만들기


  1. doxygen 이용
    1. 만들 수 있는 파일 포맷
      1. html
      2. rtf
      3. pdf
  2. visual studio의 속성을 이용하여 xml 문서 만들기
    1. 만들 수 있는 파일 포맷
      1. xml

-  visual studio의 속성을 이용하여 xml 문서 만들기 방법

1. 옵션 설정


2. 주석 처리

예) 

 /// <summary>

   /// GetZero method

   /// </summary>

   /// <example> This sample shows how to call the GetZero method.

   /// <code>

   /// int main() 

   /// {

   ///    return GetZero();

   /// }

   /// </code>

   /// </example>

const char* GetString()

{

return "Hello";

}

3. 빌드 하면 debug 폴더에 xml 파일이 생성된다