개발문서 자동화 시도하면서 생긴 문제

 프로그래밍을 하다보면 인수인계를 위해서던, 스스로를 위해서던 개발 문서에 대한 필요성을 느끼게 됩니다. 처음 아무것도 모를때는 회사에서 시켜서 개발문서를 작성하였는데, 페이지별로 함수 하나하나 이름과 기능, 사용법 등을 적어서 만들었습니다.

물론 자동화할 수 있는 뭔가가 있지 않을까 싶었지만, 검색 능력 부족으로 언제까지 찾기보다 어떻게든 만들어야겠다는 열정으로 작성했습니다.

그래도 유튜브 알고리즘의 축복인지 곰튀김님의 마크다운 문서화 를 보았고, 이걸 적용해보자고 생각하였습니다.

 

우선 기존 프로젝트에다가 적용해보았습니다. 그런데 바로 문제가 생겼습니다. 바로 xcodebuild 에러가 떠버렸습니다.

 

xcode를 빌드해도 아무 문제없고 실행도 잘 되었기에 문제가 뭔지 몰랐습니다. 로그 파일에 라이브러리 부분에 체크가 되어 있어서, 라이브러리를 최신 업데이트했습니다. 

그런데도 똑같은 문제로 문서화가 되지 않았고, 혹시 jazzy자체가 문제인가 생각해봐도 지속적으로 관리되는 라이브러리 같았습니다.

 

계속 고생하다가 stackoverflow에서 문서화하려는 프로젝트의 코드를 고쳐야한다는 글을 보고서, 프로젝트의 코드 자체가 문제가 아닐까 싶었습니다. 테스트로 새 프로젝트를 만들어 주석만 추가해서 테스트해보니 바로 문서가 생성되었습니다. 그래서 문서화 하려는 기존 프로젝트를 둘러보니, 스토리보드상에서 오토레이아웃을 안 넣어서 준게 있었는데 그것이 에러가 나있는 상황이었습니다. 이게 스토리보드로 오토레이아웃 잡기 애매한 곳을 다시 코드로 잡다보니, 코드 + 스토리보드로 작동하는 실행시에서는 제대로 작동하는데, 스토리보드만 보자면 오토레이아웃이 제대로 잡혀있지 않기 때문에 생긴 문제였습니다.

 

이 프로젝트를 깔끔하게 고쳐보려 해도  아예 코드로 바꾸지 않는 이상 힘들 것 같아, 이 프로젝트의 문서화는 넘기고 다음 프로젝트부터는 제대로 문서화를 적용시켜보려고 합니다. 스토리보드 연습을 위해서라도 불편한 스토리보드로 작성했던 프로젝트인데, 이제는 코드 or 스위프트UI가 자리잡아가면서 스토리보드를 버리는 추세로 넘어가니, 스위프트UI로 작성해서 문서화를 적용시켜보려 합니다.