티스토리 뷰
코드 수정과 기능 추가를 하다가 갑자기.. 다른 분들은 어떻게 주석을 달까? 라는 궁금증에 프로그래머 주석이라고 검색을 해봤다.
그러다가 해당 링크에 관련 된 내용을 보게 되었고, 주석을 꼭 달아야 한다와 굳이 안달아도 상관없다라는 식으로 나뉜 것을 보았다.
음.. 나는 하나하나 주석을 다는 편이다.. 물론 코드를 수정하는 과정에서 주석을 수정 못할 때도 있지만, 그럴 경우에는 코드를 한 번 훑어보고
틀린 주석은 수정하는 편이다. 왜냐하면, 내가 이 프로젝트를 혼자 계속 할리는 없을 것이고, 누군가는 또 이 프로젝트를 건드리는 날이 올텐데..
주석을 달아놓지 않는다면, 누군가는 이건 뭐지라고 생각할 것이다. 나 또한 프로토 타입을 받을 때 뭔 소리야. 주석 하나 없이 코드도 엉망인데
뭘 어떻게 알아먹으라는거야 하면서 계속 참조 찾기를 하면서 코드 분석을 한 경험이 있기 때문이다.
그리고, 아무리 가독성이 좋은 코드라도 모르는 사람이 있을 경우가 있기 때문에, 비슷한 코드는 몇번 주석을 달고
또 다른 비슷한 코드가 나오게 된다면, 굳이 설명을 안해도 될 거라고 믿음. 이라는 주석을 단다ㅋㅋㅋㅋㅋㅋ
몇 번 보다보면 이해가 가기 때문이다.
그렇기 때문에, 나는 주석을 달아놓는 게 좋다고 생각한다. summary 라든지, 그냥 기본 주석이라던지 말이다.
하지만 누군가는 주석을 아예 달지 않거나, 조금씩 달아놓는 편이 있을텐데 코드가 이해하기 쉽게 만들어졌다면 모르겠지만
진짜 스파게티 코드 또는 무슨 말인지도 모르는 함수명 변수명을 써놓는다면, 진짜 다음 사람은 죽어봐라라는 식밖에 안된다고 본다.
개인적인 생각일 뿐이다. 누군가는 다르게 생각할 수도 있으니깐 말이다.
'게임 프로그래밍 ( 이제 안함 ) > 일에 대한 끄적끄적' 카테고리의 다른 글
Final IK - VRIK.cs 주석 작성 (0) | 2019.11.14 |
---|---|
VR - Steam VR SteamVR_Behaviour_Pose.cs 주석 작성 ( 틀린부분은 말씀해주세요! ) (0) | 2019.11.05 |
VR - Steam VR UIElement 스크립트 주석달아보기 (0) | 2019.11.04 |
VR - Steam VR LaserPointer 스크립트 주석 달아보기 (0) | 2019.11.04 |
아이폰6 망할것 (0) | 2018.12.12 |
- Total
- Today
- Yesterday
- VR
- 유니티
- c#
- baseofcoding
- Next.js
- spring boot
- Java
- HTML
- 유니티3D
- 뷰포리아
- 안드로이드
- JSP
- 비지니스 로직
- Vuforia
- CSS
- 서블릿
- Base Of Coding
- 프로그래밍
- 스프링
- Spring
- 유니티로 배우는 C#
- Unity
- 게임프로그래밍
- Git
- unity3d
- Servlet
- MVC
- GitHub
- Controller
- 프리젠테이션 로직
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | ||||||
2 | 3 | 4 | 5 | 6 | 7 | 8 |
9 | 10 | 11 | 12 | 13 | 14 | 15 |
16 | 17 | 18 | 19 | 20 | 21 | 22 |
23 | 24 | 25 | 26 | 27 | 28 |