안녕하세요.
현규완입니다.
어제 밤에 의문점이 생겨서 코드를 보러 들어 갔습니다.
지지난주에 제가 주석을 달때 우리가 주석 단 것을 구분 하기 위해
"@@" <= 이렇게 해서 달기로 부탁을 하셨죠.
그 이후로 계속 @@로 달고 있었습니다~
그런데 이번에 보니까 중간 중간 "//" 이렇게 달려 있는 주석이 있더라고요~
사람들이 모두 다르고 추구하는 바가 달라 주석 스타일이 다르지만...
이렇게 매번 달라지다 보면 하나의 파일에 20명의 스타일이 생겨 버릴거 같은 느낌이 들더라고요.
그러니 저희 팀만의 코딩 스텐다드를 만들었으면 좋겠습니다.
(*코딩 스텐다드 : 코딩 할 때 같은 규칙을 새워서 한 사람이 짠거처럼 보이게 하는 방식(정확한 정의는 아님니다.ㅎㅎㅎ))
주석을 달 때 필요한 것들이 뭐가 있는지 제 맘대로 아래 적도록 하겠습니다~
원하는 방식이 있으면 알려주시면 저도 수정 하면서 업데이트 하도록 하겠습니다~
======================================================
1. 소스 드라이빙 시작과 끝
@@@START 130702
@@@END 130702
C 소스에서는 앞에 "//" 를 붙이도록 하겠습니다.
2. 주석 추가
@@ 주석~!!!
3. 다음 줄로 넘어가는 주석
@@ 할말이 아직 안끝났는데.... 너무길어 다음 줄로 넘어가야 할거 같을 때는
@@ 이렇게 해서 위와 이어지는 내용임을 알린다. (역슬래시가 있는겁니다~~)
4. 해야할 일
@@TODO(130702) : 내용 적기
======================================================
일단 이렇게 하면 어떨까...
저 혼자 생각해 보았습니다.
A팀의 의견을 묻고 싶네요~
비 많이 오는데...
모두 몸 조심 하시고요~
댓글 12
-
리누즈박
2013.07.02 13:19
-
HyunGyu
2013.07.02 15:30
공감하신다니.. 다행입니다.^^
2년 후에는 주석만 남을 텐데..
주석이라도 보기 좋게 달려구요.ㅎ -
kmasta
2013.07.02 13:23
저도 이거 생각은 하고있었는데 좋은 아이디어가 없어서 가만히 있었는데 ...
좋은 의견인거 같아요...
-
HyunGyu
2013.07.02 15:32
제가 글을 써서 먼저 선수 쳤네요~
더 좋은 방법 있으면 추가해주세요~~^^ -
K
2013.07.02 13:55
@@@START 130702
@@@END 130702
@@TODO(130702)
요런 키워드는 상당히 유용하게 사용될 듯 합니다. 전 좋습니다.^^
-
K
2013.07.02 18:23
저도 나서는데요 뭘~ ㅋㅋㅋㅋ (ㅡㅡ)
... a형 개발자가 ... -
HyunGyu
2013.07.02 15:36
ㅋㅋㅋ
이기환님도 맘에 드신다니...
잘 썼다는 생각이..ㅋㅋ
괜히 나서서 "젠 맨날 나서.."라고 생각하지 않을까 매번 걱정이네요..ㅋㅋㅋ
에이형 개발자의 걱정입니다..ㅋ
아이디어 있으면 추가 해주세요~~ -
K
2013.07.24 14:13
코딩 커멘팅 스타일 제안내용을 아래 위키에 정리해두었습니다.
http://iamroot.org/wiki/doku.php?id=스터디:kernel_스터디_10차_arm_a#코딩_커멘팅_스타일_제안
개선 혹은 추가할 내용이 있으면 위키에 바로 수정하시면 좋겠습니다.^^
-
HyunGyu
2013.07.25 10:12
이상하게 위키는 보긴 하는데.. 손이 안갔는데..
올려 주셔서 감사합니다~^^
-
유희재
2013.07.25 09:19
C 코드로 들어갔을경우도 생각해서 결정 하세요 ^^
-
HyunGyu
2013.07.25 10:11
조언 감사합니다~~^^
@@를 이용해서 잘~~ 만들어 봐야 겠네요~
-
K
2013.07.25 10:18
아직은 어셈코드만 보다보니 C 코드에서 저희 주석이 어떻게 보일지에 대해 많이 생각은 못해봤네요..
한번 논의해봐야겠습니다.
조언 감사합니다.^^
.
소스코드가 방대하니까 나중에 찾아보려면 규칙이 필요하겠군요.
좋은 생각이십니다. ^^