코드 로직 문서화 관련하여, 저는 예전에 높은 복잡도를 가진 서비스를 개발 할 때, 코드에 아스키 아트로 로직을 적어 넣었던 적이 종종 있습니다.
플로우를 화살표로 넣는 정도 수준이 아니라, 여러 도형의 조합으로 표현되는 것이었는데요.
개인적으로는 그렇게 작성 한 이후 참고가 많이 되어서 좋았던 경험이 있습니다.
GitHub이나 Jira이슈, 혹은 다른 문서로 만들어 두는게 좋다고 생각 할 수도 있지만, 끝까지 온전히 남는 문서는 결국 소스 코드 밖에 없거든요. 참고할 문서가 어디 있는지도 정확히 알 수 있고요.
그래서 문서는 코드에 주석으로 최대한 작성 한 후, 거기서 포매팅된 문서를 뽑아내는게 가장 좋은 방법이라고 생각합니다. 물론 사전 적업의 편의성이나 이쁜이 작업이 부족하다는 단점이 있어서, 요즘은 좀 기피되는 것은 시대의 흐름인 것 같지만요.
더 많은 콘텐츠를 보고 싶다면?
이미 회원이신가요?
2024년 3월 30일 오전 11:02