1. 소스코드의 길이가 길어진다.
이거 간과할 문제가 아니다.
너의 코드찾는 시간은 훨씬 더 훨씬 늘어날꺼다. ( 스크롤 해야할량도 늘어날테고 )
사람의 눈은 8개를 초과한 항목을 한 눈에 찾을 수 없다.
2. 유지관리의 대상이 늘어난다.
함수나 코드의 위치를 옮길때 주석도 같이 가지고 다녀야 한다.
함수의 기능이 변경될 때 주석도 수정해야 한다.
그렇지 않다면 주석과는 다른 코드에 우왕좌왕할테고 배신감을 느끼게 될꺼다.
3. 두 개의 언어가 공존한다.
읽는 사람까지 합치면 세 개의 언어다.
몰입감이 떨어지고,
두 가지 언어를 마스터한 사람을 필요로 한다.
즉, 니가 중국어 주석이 붙은 소스를 인터넷에서 본다면 넌 중국어도 공부해야 한다.
4. 자연언어는 사실 아주 많은 착각을 불러일으킬 수 있다.
심지어 띄어쓰기만으로 전혀 다른 문장이 된다.
ex) 이루어질 수 없는 사랑
이루어질... 수없는 사랑
자연어는 지역 / 세대 마다 의미를 조금씩 다르게 한다.
5. 특히 한글은 복잡도가 높고 심미감이 떨어진다.
중국어에 비할바는 아니다.
하지만 충분히 시선을 뺏는다.
6. 일부만 붙어있는 주석, 이것도 웃긴거다.
완성도 있는 소스코드라면 주석을 붙이는 것에도 일관성이 필요하다.
흔히 인터넷에서 formal 하게 작성된 소스코드 (doxygen) 에서
빈껍데기 주석들을 보게 될꺼다. 결국 작업해야 할 양이 는다.
자연어로 표현되는 어휘나 문장에까지 코딩스타일을 정형화하기란 어렵다.
7. 네이밍을 잘 따서 적당히 함수로 싸면 솔까말 주석 필요없다.
주석은 코드로 바뀌어야할 숙제일 뿐이다.
숙제 안하고 노는 애들이 주로 주석을 단다.
즉 주석은 핑계다.
결론. 주석은 죄악이다. ( to do 정도는 참아준다. 압축률 높은 신호로 간주 -> 어차피 지울 것 )
프로그래머라면 코드로 말해야 한다.
흠 그니까 주석같은걸 달다보면... 실력이 안늘고 실력이 절정에 이르면 주석은 방해만 되니 주석을 달지 말자?
응. 네이밍과 구조를 다듬는데 더 노력해야 한다.
Kia! 동감! 꼭 코딩 못하는 생키가 코드나 vcs 주석을 길게 쓰더라구. 우린 용서 못하지. 난 가끔 기본 아이디어를 간단히 쎃놨다가 나중에 코드로 바꾸거나, 존재하는 문제점을 써놨다가 해결책을 발견하면 고치는 용 외로는 잘 안쓰는게 사실임 ㅋㅋ
ㅇㅇ 그게 정상이다.
ㄹㅇ 쓸데없는 주석 있으면 가독성 떨어지고 거슬림
그렇지. 쓸모 있는 주석이라면 그건 코드로 바꿔야 할 숙제를 덜 끝낸거고.
*/
글고보니 저번에 함수의 길이는 7줄?을 넘지 않게 짠다는 말을 한 적이 있는 것 같은데 그게 저 8줄이 한눈에 들어올 수 있어서임?
구구절절 맞는말인듯 하지만 세상에는 좆밥이 훨씬 많습니다 횽님 ㅠㅠ 자기 의도도 제대로 표현 못하는 애들이 많아 주석이라도 달아야 아 요놈이 그거 짤려고 이따위로 했구나 알게 됩니다요
빡대가리라 예시도 보여줫으면
ㅅㅅ 말도 맞다 그래서 며칠전에 자기의도와 전혀멀게 코딩하는 좁밥들 코드리뷰 해줄때나 도움 되더란 말을 한거지 즉 주석은 잘봐줘야 기저귀다
난 30줄을 넘지 않는다 했고 평균내면 7줄 정도라 말함 주로 서너줄
클린코드에서도 주석은 안쓰는게 제일좋지만 함축적인 의도를 설명하는것이 좋다고 함
ㅇㅇ 안쓰는게 제일 좋음.
그럼 주석말고 아예 그 소속의 전부를 해설하는 매뉴얼 같은거는 어떰?
소속 => 소스
분리해두면 괜찮슴다~
( 어차피 난 매뉴얼 따위 안 볼꺼니깐 )