728x90
1) 파일 맨위의 상단에 붙이게 되는 Box 입니다.
//----------------------------------------------------------------------------
// FILENAME : ..... .h
//
// Classes
//    * 클래스1 이름
//      - 설명
//    * 클래스2 이름
//      - 설명
//
// Handlers
//    * 작업자 명 : ID
//
// Memo
//   [05/04/20 12:00] id [catergory] :  메모 네용
//
// Update List
//   [05/04/20 12:00] Update 내용1
//   [05/04/20 12:00] Update 내용2
//----------------------------------------------------------------------------

* FILENAME
설명이 필요하겠습니까? 그냥 파일 이름

* Classes
여기에는 현재 .H 에 등록된 Class들을 적습니다. 물론 VC 스타일로 작성하게
되면 이상하게 한개의 파일안에 한개의 Class가 상주하게 되지만, 꼭 그럴 필요는 없죠
여러개의 Class가 한개의 파일안에 상주 할 수 있으니깐요.
설명은 굳이 방법은 제시하지 않지만 외부에서 사용하는 사람이 편하게 내용을 서술해
주는 것이 좋죠.

* Handler
작성자인 author 라고 쓸수도 있지만, 이 파일을 여러사람이 만지는 경우에는 꼭
그렇지는 않죠. 작성한 사람이나 편집하는 사람이 있으니깐요.
그렇다고 Author, Editor 나누기도 그렇고... 그냥 Handler 조작하는 사람들이라고
해버렸습니다 .
여기에는 이 파일에 손대는 사람들을 기록하는 부분입니다.
일단 "실명 : ID " 형태를 취하는데, 이유는 메모나 업데이트 부분에 그 밖에 여러가지
기록할때, 실명을 일일히 적는 것보다 ID로 적는게 타이핑 수도 줄이고 알아보기도 편하니깐요.
저 같은 경우에는 "김형진 : neohind" 라고 적을 예정입니다.
아, 여기서 Main Handler는 최상단에 위치해야 됩니다. 최소한 소스 책임질사람이
있어야 되니깐요.

* Memo
일단 각종 잡담 부터 시작해서 경고 요청 등등의 내용을 기록하는 부분입니다.
항목(Category) 부분은 계속 업데이트 하겠지만... 일단 간단하게 다음 정도로
적고 싶습니다.

  TODO : 해야 될 내용 - 추후에 첨가되길 바라는 것들
  DEL : 삭제되어야 될 내용 - 릴리즈시 삭제되길 원하는 내용
  ETC : 진짜 잡담 - 그냥 소스로 대화하고 싶을때(笑)
  CAU : 주의 사항 - 소스 사용시 주의 사항
  REF : 참고사항, 다른 소스(코드가 아닌 정보)를 참조할 필요가 있을때,

작성 예는 다음과 같습니다.
[xx/xx/xx xx:xx]  id [????] : 내용
  xx 부분은 당근 날짜와 시간이 들어갑니다.
  id 는 위에서 Handler에 기록한 ID를 적으면 되구요
  ???? 는 Category를 의미합니다.
  내용에는 당근 자세한 설명이 되겠죠. 가급적 1줄로 해결을 봤음 합니다(笑)
   예) [05/04/20 12:00] neohind [ETC] : 이봐.. hind, 소스가 웃기잖아!!!

* Update
이 부분은 Versioning에 관련된 부분입니다. 가급적 소스의 메인 핸들러가
작성하는 부분이 되는데, 소스 버젼 업그레이드 될때 마다 기록해 줍니다.
어떻게 업데이트 되었는지를 로그로 남기는 부분입니다.

--------------------------------------------------------------------------
2) 코드 재 참조 방지용 #ifndef 작성
보통 Header 부분은 많은 곳에서 #include를 수행하게 됩니다.
이 때 Header의 재참조를 막기위해서 전처리기용 예약어를 이용해서 만드는데,
이 부분에 대한 설명입니다.
#if !define ??? 뭐 이렇게도 적을 수 있지만.. 통일성을 위해 아래와 같이 이용합니다.

#ifndef __[HeaderFilename]_
#define __[HeaderFilename]_
    .....
#endif // __HeaderFilename_

__HeaderFIlename_ 이 부분은 "__"  + 파일명 + "_" +확장자 + "_" 의 구성으로
작성합니다. Header의 Filename을 서술시에는 반드시 전체 대문자로 기록합니다.
Service.h 를 작성한다면 __SERVICE_H_ 라고 합니다.



728x90

+ Recent posts