[💬] 코드 문서화하면 보통 어케함?

[달벌레(jkle1005)]

클래스, 함수, 변수 다 적고 

이 클래스는 뭐에 쓰는거고, 이 함수는 뭐에 쓰고 어떻게 쓰고, 이 변수는...

보통 이렇게 하나하나 다 씀?

[산적대왕(125.137)]

프로그램 진입지점이랑 큰 클래스간에 뭘 주고받는지 정도만 기술해도 큰 도움되는듯. 기능 다 서술할거면 코드내에 자바독 주석을 좀 달고 독시젠으로 뽑는게 편함. 무엇보다 문서화가 필요한 상태인가를 생각해보는게 먼저인듯.

[달벌레(jkle1005)]

지금은 혼자 코딩하는데 나중에 더 들어올수도 있고, 버전 관리도 할라면 필요해보여서 할라고 함. 독시젠 찾아보니까 괜찮아 보이네 ㄳ

[익명(218.157)]

개인적인 의견으로는 코드 규모가 작은 상태고, 코드 숨기는 라이브러리화 할 것이 아니라면 문서화가 굳이 필요할까 싶어. 코드를 보면 되는데 변수 하나하나 일일이 설명을 써주는건 낭비가 아닐까? 꾸준히 최신화 관리 안하면 안하느니만 못한 부분도 있고, 차라리 작게 함수화 시키고 읽기 편한 코드를 쓰는 편이 나은 것 같아.

[익명(122.43)]

님 울회사오면 뺨맞음 ㅋㅋ

[익명(122.43)]

모든 코드는 신입이 한달 교육만 받아도 읽는데 지장 없도록이 원칙인거셈 ㅋㅋ

[익명(218.157)]

글쓴이가 혼자 코딩한대잖아..

[익명(175.223)]

픽스쳐를 잘만들면 그게 곧 문서화임 - dc App

[익명(175.223)]

유니티 메뉴얼이나 깃 페이지들 참고해 - dc App