|
1) 지식 창고는 본인이 작성한 콘텐츠(팁/노하우/리소스/강좌 등)을 무료 혹은 가상화폐인 납포인트를 통해 공유하는 공간입니다.
2) 본인이 작성한 콘텐츠에 대해서만 지식 창고에 등록할 수 있으며, 저작권에 위배되는 콘텐츠는 사전경고 없이 삭제될 수 있습니다.
3) 콘텐츠 구매 및 첨부파일 다운로드는 회원그룹 '연구원' 이상 가능하오니, 경험치를 쌓아 진급한 후에 이용 부탁드립니다.
4) 무료 콘텐츠의 본문은 구매절차 없이 즉시 이용할 수 있으며, 판매 납포인트가 있는 콘텐츠는 구매 후 이용할 수 있습니다.
5) 콘텐츠 판매에 따른 납포인트 수익은 지정한 비율(50%)에 따라 판매자에게 지급하며, 납포인트 수익을 통해 진급을 빨리할 수 있습니다.
6) 구매 후 평가를 하면 구매 납포인트의 20%를 돌려 드립니다.
콘텐츠 수 185
| 판매자 | 빛나는 영혼 | 판매 납포인트 | 무료 | 평점 |   3.7점 / 총 7명 참여 |
|---|
안녕하세요.
보통 함수 이름 지을때 사용하다 보니까 함수가 많아지면 헷갈리더라구요,
그래서 보통
void sum ( void ) // 더하기 함수
이렇게 하면 에디터 등으로 볼때 옆의 주석이 보이는 에디터가 있습니다. 이런걸 사용하거나
혹은 Source Insight 에디터를 사용하면 다 볼 수 있구요.
전 이름에 다 표기하는 것을 좋아하는데
예를 들어 float 를 반환하는 함수에 인자값 float 가 두개 있고 그 함수가 COMM.C 에 있다고 하면
// ... 주석 ( 함수의 자세한 사항 및 주의사항 )
comm_f_f_fReturnFunc ( float fBuf , float fBuf ) ; // 주석.. (간단한 함수 설명)
이렇게 짓습니다.
그러면 편리한게 반환값을 알수 있고 어디에 있는 함수 인지 알 수 있고 함수 인자값을 무엇을 주어야 하는지
알 수 있습니다.
그리고 comm.c 에서는
내부에서 사용하는 함수와 외부에서 사용할 수도 있는 함수로 나누고
외부에서 사용할 함수에만 comm_.... () 이름을 짓습니다.
내부에서 쓰는 것은 굳이 앞에 comm_ 이라고 해서 알리질 않아요.
그런데 하다보면 귀찮아서 막 쓰기도 하고 그러고 하네요.
좋은 방법 있으면 가르쳐 주세요. ^.^
보통 함수 이름 지을때 사용하다 보니까 함수가 많아지면 헷갈리더라구요,
그래서 보통
void sum ( void ) // 더하기 함수
이렇게 하면 에디터 등으로 볼때 옆의 주석이 보이는 에디터가 있습니다. 이런걸 사용하거나
혹은 Source Insight 에디터를 사용하면 다 볼 수 있구요.
전 이름에 다 표기하는 것을 좋아하는데
예를 들어 float 를 반환하는 함수에 인자값 float 가 두개 있고 그 함수가 COMM.C 에 있다고 하면
// ... 주석 ( 함수의 자세한 사항 및 주의사항 )
comm_f_f_fReturnFunc ( float fBuf , float fBuf ) ; // 주석.. (간단한 함수 설명)
이렇게 짓습니다.
그러면 편리한게 반환값을 알수 있고 어디에 있는 함수 인지 알 수 있고 함수 인자값을 무엇을 주어야 하는지
알 수 있습니다.
그리고 comm.c 에서는
내부에서 사용하는 함수와 외부에서 사용할 수도 있는 함수로 나누고
외부에서 사용할 함수에만 comm_.... () 이름을 짓습니다.
내부에서 쓰는 것은 굳이 앞에 comm_ 이라고 해서 알리질 않아요.
그런데 하다보면 귀찮아서 막 쓰기도 하고 그러고 하네요.
좋은 방법 있으면 가르쳐 주세요. ^.^
2010.05.02 15:59
지금 검색해 봤는데 상당히 좋네요. 기존엔 readme.txt를 따로 만들어서 관리 했는데.. 소스에는 날짜를 표기하구요.
날짜 표기하면 울트라에디터에서 날짜만 검색해도 무엇을 수정하였는지 알수 있거든요.
약간 저에겐 안맞는듯 하지만 좀더 공부해 보면 상당히 유용한 툴일듯 하네요.
좋은 정보 감사드려요. 왜 예전에는 이런 것을 몰랐지 -_-;;; 역시 사람에겐 여유가 있어야 되나 봅니다. ^.^
2010.07.05 12:58
hungarian notation이라고 검색해보시면 표준화된 것이 있는데요.
string -> sz_variable
int -> n_variable
float -> f_variable
등등이였던거 같은데요... (요즘 script language만 사용해서 ..)
2010.07.14 11:53
네. 저두 함수명이나 변수등 그때그때 만들어 쓰다보니, 나중엔 제가 만든 것도 헷갈리는데, 규칙을 정해놓고 이름을 만들면 용이하겠네요. 수정 부분 버전을 날짜로 소팅하는 방법도 유용할 듯...
- 하드웨어 설계 (610)
- 임베디드 & 프로그래밍 (1,041)
- PCB Layout & ECAD (696)
- 강좌 & 팁 (120)
- 자작품 & 회로도 모음 (185)
저작권법에 위배되는 콘텐츠는 등록 불가하며, 저작물에 대한 권리는 저작자에게 있습니다.
Copyright 2006-2021 © hardwareis.com, All rights reserved.
저 같은 경우는 특별히 함수 이름 짓는 것에 대해서는 생각해 보진 않았습니다만..
보통..함수는 대문자로 시작하고 그 기능에 대해서만 표현했던 것으로 생각됩니다.
개인적으로는 주석을 Doxygen에 맞게 달려고 하는 것에 대해서 한표 던져봅니다.
좀 큰 회사에서 소스 문서화 메뉴얼들이 Doxygen으로 작성된 것들이 상당 수 있더군요.
P.S. : 그런데 Doxygen쓰는 것도 개인적으로 하면 잘 안되는 듯 합니다...
아무래도 위쪽에 있는 사람이 아랫사람에게 꼭 쓰도록 지적을 해줘야 이런 부분이 될 듯 한데..
제 위에 사람이 없다보니....귀찮아서 그렇게 잘 안하는 듯 합니다. ㅡㅡ
여하튼..Doxygen상당히 좋습니다. ....주석만 잘 달면..상당히 고품질의 Document가 생성됩니다.