이제 협업을 염두해두고 또 협업을 하면서 제 코드를 누군가에게 공유하고 나누는 일이 많이 생기는데. 이제까지 누군가의 코드에 comment를 한적도 본적도 없어서… 또 어떻게 해라… 이런 설명을 들은 적이 없어서 좋은 주석을, 도움이 될만한 주석을 적는 방법? 팁? 노하우? 형식? 표준? 같은 것이 궁금합니다:)
일일이 적으려니 너무 많고 너무 요약하자니 설명이 부족한데, 어떻게 하면 좋을까요?
좋아요 2
주석에 대한 가이드라인이 있으니까 참고해보세요.
- Swift의 API guideline : Swift.org - API Design Guidelines 에서 Write a documentation comment 부분
- 구글의 스타일 가이드 : Swift Style Guide
- Swift Documentation - NSHipster
가이드라인은 가이드라인이고, 프로젝트 내에서 주석을 작성할 때는 프로젝트 성격에 따라서 다른거 같습니다.
다른 앱에서 사용하는 프레임워크를 만드는 프로젝트를 할 때에는 저 가이드라인을 참고해서 좀 간략화한 형태로 작성했습니다.
그외에는… 가이드라인에 맞춰서 작성하기 힘들어서 많이 생략합니다.
다만 여러 가지 구현 방법 중에서 하나를 선택한 이유 같은거는 꼭 작성하는 편입니다.
좋아요 3
감사합니다! 달아주신 링크 참고해서 공부해보겠습니다:)
좋아요 2
여력이 된다면 SwiftLINT 를 도입해 보길 권합니다.
코딩 컨벤션에 맞지 않은 코드를 에러로!!! 만들 수 있어요.
좋아요 1