[SW종합설계] Marhen 문서화

  1. 문서화 기본적으로 README를 하나하나 사람이 직접 만드는 것은 생각보다도 복잡하고 많은 시간과 노력을 필요로 한다. 스크립트의 양이 많고 복잡하기 때문이다. 또한 아주 상세하게 작성된 설명은 사실상 코드를 직접 보는 것과 차이가 없을 수 있다. (고도로 발단된 설명은 코드와 다를 바 없다.) 차라리 코드에 대한 최소한의 설명을 주석으로 추가하는 것이 올바를 수 있다. 이에 정해진 규칙에 따라서 작성된 주석을 자동으로 문서화하는 프로그램을 사용할 수도 있다. 3줄 요약 2. 방법 ChatGPT 왈 아래 표는 Doxygen, Sandcastle, DocFX에 대한 간략한 비교입니다. (출처 : GPT4.0) 2번의 코드 문서화 도구들 중 Doxygen을 활용해서 코드를 문서화를 시도해 보겠다. (시간 있으면 DocFX도 시도해 보겠다.) 3. … 더 읽기