전 변수 하나하나마다 다 달아놓고
변수 축약해서 선언할때는 원래 변수의 풀네임
주석달고
함수에는 변수의 역할 ,
임시 변수에는 왜 이걸 임시변수로 했나
그런것들 다 써놓거든요.
우선 제가 머리가 나빠져서 하루 다음날도 까먹는 일이 허다해서요.
좀 과하다 싶을 정도로 달거든요.
아 근데 요즘 남의 소스 보는 중인데
자기만 아는 축약어 + 주석 없음
함수 하나 보는데 5-6 함수는 건너가면서 봐야 변수역할이랑 네이밍을 알게되는데 아주 미치겠습니다
변수 축약해서 선언할때는 원래 변수의 풀네임
주석달고
함수에는 변수의 역할 ,
임시 변수에는 왜 이걸 임시변수로 했나
그런것들 다 써놓거든요.
우선 제가 머리가 나빠져서 하루 다음날도 까먹는 일이 허다해서요.
좀 과하다 싶을 정도로 달거든요.
아 근데 요즘 남의 소스 보는 중인데
자기만 아는 축약어 + 주석 없음
함수 하나 보는데 5-6 함수는 건너가면서 봐야 변수역할이랑 네이밍을 알게되는데 아주 미치겠습니다
https://www.hanbit.co.kr/store/books/look.php?p_code=E2375873090
(내가 review한다면 물어볼 만한 곳에...)
vba나 lisp 쓸때 주석 다 달아놓긴합니다. 나중에 파악하기 귀찮아서요
애초에 이해하기 어렵게 짜니 주석이 없으면 읽기 힘든 코드가 되지요.
영어가 모국어라면 그렇겠지만..
아니 어차피 자동완성이 다 하는데여 ㅠ”ㅠ
소설 써 놓은 것도 아니고 긴 게 뭐 대수라고…
get_mp4_file_status 이란 변수가 있다고 치면
gmfStat .. 이런 상황이라 ㅠㅜ
위험성이 높은 변수에만 주의 표시 수준으로 주석 달아두고..
나머지는 맨 앞단에 개요, 내부 주요 흐름 정도로만 표시해둡니다..ㅎㅎ
주로 주석을 쓰는 곳은 documentation 이 되는 함수의 설명이나 조금 복잡한 루틴을 설명하는 위치 정도네요.
주석도 일의 호흡을 끊거든요.
가급적 코드 자체가 문서 역할을 할 수 있도록 모두가 납득할 수 있는 코드를 작성하는 게 좋다고 생각해요..
변수는 축약어를 안쓰고 있어요.
주석을 다는 경우는 라이브러리 등의 버그를 우회하느라
그냥 봐서는 불필요해보이는 코드를 넣었을때(어쩌다 한번씩 생기더라구요.)
지우면 안되는 코드를 넣었을때만 주석을 달게되는거 같네요.
예를 들면 데이터시트의 주의사항 같은걸 복사해넣는다거나 식의 유도과정을 쓴다거나 등등입니다.
변수는 가능한 길게, 함수 이름도 모듈_목적물_동사 (mp3_streambuff_read) 같이 규칙을 정해놓고 만듭니다.
파일의 헤드에 doxygen 주석, 함수 헤드에 doxygen 주석 씁니다.
명명과 룰을 잘 따르면 크게 안적어도 상관없습니다. 코어로직이야 어짜피 문서화작업 수반이구요
모든걸 떠나 뭐든 코드는 적을수록 좋은것같습니다.
왜냐면 다 돈이거든요... 유지할려면...