투표 주석 논쟁

23년 05월 23일 | 조회수 1,580

alter

A: 주석을 좀 다는게 어떨까? 그래야 신규 직원 채용해도 수월할듯 B: ㅇㅇ 동의함 어떻게 작성할까 A: // 카트 추가 // productIds: 상품 번호 목록 fun addCart(productIds: [Int]) B: 이거 그냥 함수명, 매개변수명 그대로 한글로 쓴거 아님? 이럴거면 차라리 안 쓰는게 나을듯. 그냥 코드 선언부만 읽어도 이해되자나 A: 그래도 있어야함. 주석 없으면 신규 입사자 어려움 B: 저런 주석이면 여기는 cart가 뭔지 몰라서 주석으로 다나 싶어서 도망갈듯

댓글 16개

공감순

최신순

와

와대박이다

23년 05월 24일

개인적으로는 code is the best doc 이라는 말 싫어합니다. 스파게티코드 겪어보면... ㅜㅜ 최근 플러터 공부하면서 다트 공식문서보니까 주석에 대한 자세한 가이드라인도 있더군요. 함수의 경우 단순 함수명과 파라메터나열보다는 그 의미와 동작에 대한 설명을 같이 적어주는게 문서효과가 있습니다. 그리고 아키텍트 시점에서 플로우를 이해하려면 다이어그램이나 플로우차트가 효과적이므로 따로 문서 만드는 것도 결국엔 권장합니다. 적어도 깃헙에 README 정도에 간단한 그림 넣는걸 추천합니다.

(수정됨)

답글 쓰기

iliIlli0

23년 05월 24일

그래서 아키텍트 레벨로 가면 어느정도 작성자들이 이상한 코드로 가지 않도록 코드 컨벤션을 가이드 하는것도 필요하다고 봅니다. 스파게티 코드가 나온다는거 자체가 구조적으로 뭔가 문제가 있다고 생각해요.

iliIlli0

23년 05월 24일

구조에 대한 플로우차트나 다이어그램은 어느정도 규모 이상가면 이해를 위해 작성하는건 매우 좋다고 봐요.

리

리멤버

@멘션된 회사에서 재직했었음

19년 05월 28일

회사에서 풀지 못한 고민, 여기서 회사에서 업무를 하다가 풀지 못한 실무적인 어려움, 사업적인 도움이 필요한 적이 있으셨나요? <리멤버 커뮤니티>는 회원님과 같은 일을 하는 사람들과 이러한 고민을 해결할 수 있는 온라인 공간입니다. 회원 가입 하고 보다 쉽게 같은 일 하는 사람들과 소통하세요

답글 쓰기

리

리멤버

@멘션된 회사에서 재직했었음

19년 05월 28일

일하는 사람과 기회를 연결하여 성공으로 이끈다

답글 쓰기