[💬] 주석은 언제 달아야 하는걸까

[털케이크(jewelpet001)]

좋은 스크립트는 주석 없이 변수명과 함수명만 봐도 무슨 내용인지 이해할 수 있다

라는 말 듣곤 충격먹었음...

거의 5줄 단위로 주석 한 문장 씩은 우겨넣었었는데

[해당 댓글은 삭제되었습니다.]

해당 댓글은 삭제되었습니다.

[익명(125.184)]

같은 내용을 두번 봐야하는 비효율 나옴

[dualSkewer(jmm4658)]

기분 안좋은날엔 변수명asdf1~30으로 짓고 주석에 기록해놓음

[123(122.38)]

변수명과 함수명만으로는 이해할 수 없을 것 같을때

[익명(125.184)]

로버트 마틴의 Clean Code 책의 내용이랑 똑같네

[익명(175.204)]

변수명 함수명을 애초에 축약적으로 쓰는데다가 한국인이 쓰는 영어단어는 단편적인게 많아서 주석이 많이 필요하다고 본다. 그리고 변수명,함수명에 쓰이는 단어 한두개가 그기능을 모두 대변하지 못할때가 많아. 함수의 파라미터 이름만해도 Swift는 외적으로 쓰는 이름과 함수 내부에서 쓰이는 이름을 다르게 만들 수 있어서 문법적으로 의미전달에 더 유연한데 C#을 포함한 많은 언어가 그런기능은 없지.

[익명(175.204)]

애초에 언어자체가 표현력이 부족하기 때문에 불가능한 부분이 많다는 것. 그리고 주석이 너무 많으면 되려 코드 가독성이 떨어짐. 자기만 보는건 적당히 쓰는게 좋고 라이브러리로 API 공개하는 메서드,변수는 주석꼼꼼히 달아줘야한다고 생각함. 유니티 API 설명 안달아놓은거 볼 때마다 빡쳐

[익명(118.241)]

내 코드에는 주석은 거의 없음. 없어도 암

[Anonymous(220.86)]

보는 입장에 따라 다르지 var f = m*a 써놓으면 물리하는 애들애들은 바로 알지만 var force = measure * acceleration 까지 써줘도 일반인은 모를수도 있잖어. 주석은 필요하기도 하고 아니기도 함