이미 한번 똑같은 글 썼지만, 주석 없어도 된다는 건 마치 논문에 abstract나 소제목이 없어도 된다는 이야기 같음.
혹은 책 제목이나 목차가 없거나.
그러니까 주석이 필요없다는건
"내용이 중요한거지! 책 제목 같은게 영향을 주는게 아니잖아?"
같은 소리라고 들림.
그리고 주석이 필요없다고 하면서 나오는 이야기는
전부 주석을 제대로 쓰지 않아서 발생하는거지
단순히 주석이 존재해서 발생하는 문제는 아닌거 같음.
주석이 천줄 달린다고 해봤자 코드가 돌아가는데는 아무 영향을 안줄테니까-
결국 그 근본은 추가적인 유지관리가 귀찮아서- 라는 건데.
그 코드를 짠 한 사람이 제대로 주석 유지관리만 하면 그걸 훑어봐야 하는 백명 천명의 코드 읽는 시간을 단축시킬수 있는거 아닌가?
그냥 협업없이 혼자만들고 쓰는 코드면 몰라도..
하여튼 초짜이긴하지만, 주석을 보고 똥기저귀니 뭐니 하는 소리 들으니까 주석 안쓰는게 자랑인가 싶은 생각이 들어서 또 글쌈.
혹은 책 제목이나 목차가 없거나.
그러니까 주석이 필요없다는건
"내용이 중요한거지! 책 제목 같은게 영향을 주는게 아니잖아?"
같은 소리라고 들림.
그리고 주석이 필요없다고 하면서 나오는 이야기는
전부 주석을 제대로 쓰지 않아서 발생하는거지
단순히 주석이 존재해서 발생하는 문제는 아닌거 같음.
주석이 천줄 달린다고 해봤자 코드가 돌아가는데는 아무 영향을 안줄테니까-
결국 그 근본은 추가적인 유지관리가 귀찮아서- 라는 건데.
그 코드를 짠 한 사람이 제대로 주석 유지관리만 하면 그걸 훑어봐야 하는 백명 천명의 코드 읽는 시간을 단축시킬수 있는거 아닌가?
그냥 협업없이 혼자만들고 쓰는 코드면 몰라도..
하여튼 초짜이긴하지만, 주석을 보고 똥기저귀니 뭐니 하는 소리 들으니까 주석 안쓰는게 자랑인가 싶은 생각이 들어서 또 글쌈.
코드는 사람이 읽으라고 만든건데 다른 사람이 못 읽어서 따로 주석을 달아야 될 정도면 다시짜야지
코드로 표현되지 못하는 정보가 따로 있다면 그것에 대해서 적는 정도면 모를까
naming 하고 documentation부터 똑바로 하고 주석달자
뭐 형같은 사람은 머리속 생각을 코드로 그냥 바꾸는건데, 생각 자체를 엄격한 언어로 표현한게 코드 자첸데 애매모호 한 인간의 언어로 다시 설명한다? 형의 "프로그래닝 중복 제거 원칙"에 따라 둘중 하나는 제거되야 한다
코드를 못읽어서 주석을 다는게 아니라 굳이 수십 수백줄의 코드를 보면서 해석하면서 시간낭비 하고있을 필요가 없게 세줄요약 하는거라고 봅니다.
220.117.*.*// 그게 안되면 주석이라도 달아야한다고. 그리고 그걸로 다 해결될리가 없다고.
index는 이름만 잘만드는거 아닐까
주석을 과도하게 도배하는게 문제지, 주석을 적절하게 쓰는게 잘못일 이유가 없다. 본문에 초록 얘기도 했는데, 초록도 쓸데없이 길게 장황한게 문제지, 적절하게 요약 잘해놨으면 좋은거고, 주석다는 것도 마찬가지.
주석은 협업에있어서 정말중요함
코어단 소스를 협업해서 만드냐? ㅋㅋㅋㅋㅋㅋ
주석 논쟁도 탭-스페이스 논쟁급 ㅇ
그럼 코어는 혼자 만들고 영원히 아무도 못보게 봉인해놓는 그런건가요?
다른 사람이 본다는 전제하에서는 꼭 달아야한다고 보는뎅.
자꾸 주석을 달아야 다른사람이 볼 수 있다고 그러는데 그게 그냥 니 코드가 엉망이라 그런거라니까
사용자들이 접근해야 하는 인터페이스 설명은 소스코드에 떡칠하는게 아니라 분리해야 된다고.
레퍼런스 목록과 예제를 주면 좋지 당연히.
그걸 코드에 끼워 붙여서 돌아다니는게 미친짓이란거지.
그리고 좋은 레퍼런스 보다 레퍼런스를 안봐도 되는 코드가 당연히 더 잘만들어진 코드 아님? 뭔 말이 길어?
간단하게 예를 들어서 "주석은 필요없다"라는 말만 쓰고 튀면 사람들이 이해할 수 있냐? 주석이 왜 필요 없는지 "설명 주석"을 달아줘야 이해하는거 아니야? 무조건 간단한게 베스트는 아니야. "이해력, 가독성"도 분명하게 중요한거지. "주석은 필요없다" 이 한마디가 "주석이 필요한 이유"를 설명해줌.
그리고 "주석은 필요없다"는 한마디는, "그래도 종종 필요한 주석은 달아주는게 맞다" 이런의미를 내포하고 있지 않음. 설명이 필요하고 자시고를 떠나서, 명제자체도 증명 못하는데 말이 안되잖아.
이미 분리된 도큐먼트로 실컷 이야기들이 오고갔다네.
이것도 주석의 문제지.
일일이 새로오는 뉴비들마다 알아듣도록 주석 관리하고, 내부적으로 생각이 조금 바뀌면 또 관리하고 비용 아니냐?
그렇게 하면서 언제 크고 언제 개발하냐. 주석 신경쓰는건 최종 릴리즈나 픽스 무렵에 사용자 환경 생각해서 조금 해주는걸로 족함.
코드는 재사용할 수 있어도. 주석은 재사용이 힘들다.