아름다운 C++ 주석을 작성하는 방법의 예

Question

어쩌면 어리석은 질문 일 수도 있지만,보기 좋은 (짧은) 형식을 작성하는 방법이 있습니까? C++ 함수, 헤더, 변수에 대한 주석을 작성 하시겠습니까? 모든 시각적 인 예들?

Answer 1

당신이 찾고 좋은 뜻 무슨 변수

/** 
* Method description. 
* @param param1 param1 description 
* @param param2 param2 description 
* @return return description 
* @since date since method is created 
* @author who have made this method. 
*/ 

: 방법에 대한

을 여기? 나는 이런 식으로 그것을 할 ..

int c;//! loop Counter 

/** 
* compares (XOR) two Types 
* return boolean result 
*/ 
bool compare(Type l, Type r); 

그 doxygen의 형식을. 주석에 코드를 문서화하기위한 대중적인 형식이 있습니다. Doxygen은 하나이고 다른 하나는 naturaldocs입니다. 훨씬 더 있습니다. 그것의 당신의 풍미. naturaldocs 형식을 좋아할 수도 있습니다.

/* 
    Function: Compare 
    Compares two Types 
    Parameters: 
     l - lhs 
     r - rhs. 
    Returns: 
     boolean result 

*/ 
bool compare(Type l, Type r); 

DOC++ 형식도 유사합니다.

/** Comparison 
    Compare two Types 

    @param l Type lhs 
    @param r Type rhs 
    @return boolean result 
*/ 
bool compare(Type l, Type r); 

하나의 형식 만 사용하면됩니다.

Answer 2

나는이 스타일을 사용하여 선호 :

/** 
* Class name 
* Description 
*/ 

class MyClass{ 

} 

Answer 3

가장 좋은 방법은 자동화 된 도구를 추출하고 가교 문서를 만들 수있는 방법으로 그것을 할 것입니다. 보십시오 Doxygen

Answer 4

보십시오 http://www.stack.nl/~dimitri/doxygen/를보십시오. 기본적으로 형식이 해석되는 JavaDoc 형식의 이륙은 도움말 파일의 경우 어느 정도까지 이루어집니다.

나는 스스로 문서화하는 코드를 신봉하고 있지만, 몇 가지 정교한 설명이 많은 도움이 될 수 있습니다.

Answer 5

나는 다음 스타일 사용

/** variables description **/ 

클래스

:

/** 
* Class description. 
* @since date since class is created 
* @author who have made this class. 
*/ 

Answer 6

가장 훌륭한 의견은 프로그램 전체에서 일관된 의견임을 제안하는 사람들이 있습니다. 나는 슬래시 사용하는 것을 선호 :

당신이 당신의 의견에서 문서를 생성하기 위해 희망하는 경우 이러한 도움이되지 않습니다 말했다

// -- short concise comments in single lines like this 

// ----------------------------------------- 
// 
// Sectional Dividers Like This 
// 
// ----------------------------------------- 

.