|
|
|
주석 달기 (current)
|
SMaker |
2010.11.14 13:32:36 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span><ul><li><span>[in] : input</span></li><li><span>[out] : output</span></li></ul></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div><div class="eArea xe_content xe_dr_txt"><p></p><div>예) debugPrint 함수 </div><div> /** </div><div> * @brief prints debug messages </div><div> * @param[in] debug_output target object to be printed</div><div> * @param[in] display_line boolean flag whether to print seperator (default:true)</div><div> * @return none</div><div> */</div><div><br></div><p></p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254113293001">variable</h4></div><div class="eArea xe_content xe_dr_txt"><p>전역변수 혹은 클래수 내부의 변수는 변수 선언 뒤에 슬래쉬 세개 + < (///<)를 붙인 뒤에 간단한 설명을 적습니다. </p></div><div class="eArea xe_content xe_dr_txt"><p>ex) var $error = 0; ///< ErrorCode</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254114393025">class</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 class에는 다음의 command를 입력합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>class : class 이름</span></li><li><span>brief : class에 대한 간단한 설명</span></li><li><span>remarks (optional)</span></li><li><span>author, date (optional)</span></li></ul></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1254126031405">일반적인 주석</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen comment를 제외한 코드에 대한 설명은 슬래쉬 두개(//) 를 이용하되, 긴 설명이 필요한 경우에는 하나의 함수로 뽑아서 doxygen comment로 달도록 합니다.</p></div>
|
하늘03 |
2009.09.30 13:55:16 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div><div class="eArea xe_content xe_dr_txt"><p></p><div>예) debugPrint 함수 </div><div> /** </div><div> * @brief prints debug messages </div><div> * @param debug_output target object to be printed</div><div> * @param display_line boolean flag whether to print seperator (default:true)</div><div> * @return none</div><div> */</div><div><br></div><p></p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254113293001">variable</h4></div><div class="eArea xe_content xe_dr_txt"><p>전역변수 혹은 클래수 내부의 변수는 변수 선언 뒤에 슬래쉬 세개 + < (///<)를 붙인 뒤에 간단한 설명을 적습니다. </p></div><div class="eArea xe_content xe_dr_txt"><p>ex) var $error = 0; ///< ErrorCode</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254114393025">class</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 class에는 다음의 command를 입력합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>class : class 이름</span></li><li><span>brief : class에 대한 간단한 설명</span></li><li><span>remarks (optional)</span></li><li><span>author, date (optional)</span></li></ul></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1254126031405">일반적인 주석</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen comment를 제외한 코드에 대한 설명은 슬래쉬 두개(//) 를 이용하되, 긴 설명이 필요한 경우에는 하나의 함수로 뽑아서 doxygen comment로 달도록 합니다.</p></div>
|
하늘03 |
2009.09.30 13:54:23 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : input parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div><div class="eArea xe_content xe_dr_txt"><p></p><div>예) debugPrint 함수 </div><div> /** </div><div> * @brief prints debug messages </div><div> * @param debug_output target object to be printed</div><div> * @param display_line boolean flag whether to print seperator (default:true)</div><div> * @return none</div><div> */</div><div><br></div><p></p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254113293001">variable</h4></div><div class="eArea xe_content xe_dr_txt"><p>전역변수 혹은 클래수 내부의 변수는 변수 선언 뒤에 슬래쉬 세개 + < (///<)를 붙인 뒤에 간단한 설명을 적습니다. </p></div><div class="eArea xe_content xe_dr_txt"><p>ex) var $error = 0; ///< ErrorCode</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254114393025">class</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 class에는 다음의 command를 입력합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>class : class 이름</span></li><li><span>brief : class에 대한 간단한 설명</span></li><li><span>remarks (option)</span></li><li><span>author, date : 검토중</span></li></ul></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1254126031405">일반적인 주석</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen comment를 제외한 코드에 대한 설명은 슬래쉬 두개(//) 를 이용하되, 긴 설명이 필요한 경우에는 하나의 함수로 뽑아서 doxygen comment로 달도록 합니다.</p></div>
|
하늘03 |
2009.09.28 17:59:46 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : input parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div><div class="eArea xe_content xe_dr_txt"><p></p><div>예) debugPrint 함수 </div><div> /** </div><div> * @brief prints debug messages </div><div> * @param debug_output target object to be printed</div><div> * @param display_line boolean flag whether to print seperator (default:true)</div><div> * @return none</div><div> */</div><div><br></div><p></p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254113293001">variable</h4></div><div class="eArea xe_content xe_dr_txt"><p>전역변수 혹은 클래수 내부의 변수는 변수 선언 뒤에 슬래쉬 세개(///)를 붙인 뒤에 간단한 설명을 적습니다. </p></div><div class="eArea xe_content xe_dr_txt"><p>ex) var $error = 0; /// ErrorCode</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254114393025">class</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 class에는 다음의 command를 입력합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>class : class 이름</span></li><li><span>brief : class에 대한 간단한 설명</span></li><li><span>remark (option)</span></li><li><span>author, date : 검토중</span></li></ul></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1254126031405">일반적인 주석</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen comment를 제외한 코드에 대한 설명은 슬래쉬 두개(//) 를 이용하되, 긴 설명이 필요한 경우에는 하나의 함수로 뽑아서 doxygen comment로 달도록 합니다.</p></div>
|
하늘03 |
2009.09.28 17:21:27 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : input parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div><div class="eArea xe_content xe_dr_txt"><p></p><div>예) debugPrint 함수 </div><div> /** </div><div> * @brief prints debug messages </div><div> * @param debug_output target object to be printed</div><div> * @param display_line boolean flag whether to print seperator (default:true)</div><div> * @return none</div><div> */</div><div><br></div><p></p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254113293001">variable</h4></div><div class="eArea xe_content xe_dr_txt"><p>전역변수 혹은 클래수 내부의 변수는 변수 선언 뒤에 슬래쉬 세개(///)를 붙인 뒤에 간단한 설명을 적습니다. </p></div><div class="eArea xe_content xe_dr_txt"><p>ex) var $error = 0; /// ErrorCode</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254114393025">class</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 class에는 다음의 command를 입력합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>class : class 이름</span></li><li><span>brief : class에 대한 간단한 설명</span></li><li><span>remark (option)</span></li><li><span>author, date : 검토중</span></li></ul></div>
|
하늘03 |
2009.09.28 14:08:27 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : input parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div><div class="eArea xe_content xe_dr_txt"><p></p><div>예) debugPrint 함수 </div><div> /** </div><div> * @brief prints debug messages </div><div> * @param debug_output target object to be printed</div><div> * @param display_line boolean flag whether to print seperator (default:true)</div><div> * @return none</div><div> */</div><div><br></div><p></p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1254113293001">variable</h4></div><div class="eArea xe_content xe_dr_txt"><p>전역변수 혹은 클래수 내부의 변수는 변수 선언 뒤에 슬래쉬 세개(///)를 붙인 뒤에 간단한 설명을 적습니다. </p></div><div class="eArea xe_content xe_dr_txt"><p>ex) var $error = 0; /// ErrorCode</p></div>
|
하늘03 |
2009.09.28 13:49:13 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : input parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div><div class="eArea xe_content xe_dr_txt"><p></p><div>예) debugPrint 함수 </div><div> /** </div><div> * @brief prints debug messages </div><div> * @param debug_output target object to be printed</div><div> * @param display_line boolean flag whether to print seperator (default:true)</div><div> * @return none</div><div> */</div><div><br></div><p></p></div>
|
하늘03 |
2009.09.28 13:30:22 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div><div class="eArea xe_content xe_dr_txt"><p>각 function은 다음에 해당하는 command들을 표시합니다.</p></div><div class="eArea xe_content xe_dr_list"><ul><li><span>param : input parameters - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdparam</span></li><li><span>return : return값에 대한 설명 - http://www.stack.nl/~dimitri/doxygen/commands.html#cmdreturn</span></li><li><span>remarks (optional) : 따로 추가적인 내용 설명이 필요한 경우</span></li><li><span>brief : 간단한 function의 기능 설명</span></li></ul></div>
|
하늘03 |
2009.09.25 16:00:05 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p><p>모든 주석은 영어로 씁니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p>각 command는 역슬래시(\) 대신 @표시로 사용합니다. ex) @brief Comments test</p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div>
|
하늘03 |
2009.09.25 15:56:30 |
|
|
|
복원
<div class="eArea xe_content xe_dr_txt"><p>이 문서에서는 XE core code에 주석을 어떻게 달 것인지를 의논하고 정의합니다.</p></div><div class="eArea xe_content xe_dr_hx"><h3 id="h1253858039923">Doxygen</h3></div><div class="eArea xe_content xe_dr_txt"><p>Doxygen에서 문서를 만들 수 있는 포맷을 따라서 주석을 달도록 합니다.</p><p>Doxygen Commands : http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief</p><p><br></p></div><div class="eArea xe_content xe_dr_hx"><h4 id="h1253858086609">function</h4></div>
|
하늘03 |
2009.09.25 14:54:50 |