C++ 프로그램에 주석을 추가하고 있습니다. 당신은 별표 옆에 위의 의견을 쓸 때이처럼 이름을C++의 주석 처리
string House:: getName(int &size){
return name;
}
자바에서 :
/*
* @param size It passes the number of rooms.
@return name. It returns name of the house
*/
C에서이 일의 형식은 무엇입니까 ++ 의 우리가 이런 일을 있다고 가정 해 봅시다?
Visual Studio를 사용하는 경우 here은 주석 문서 용 사양입니다.
Javadoc을 언급하고 있으며 동일한 편집기 및 외부 도구로 C++에서 동일한 스타일의 주석을 사용할 수 있습니다.
코멘트 문서에는 C++ "표준"이 없습니다.
+1, 즉 doxygen. –
글쎄, 도구에 대해서는 +0.5, 주석에는 메타 데이터 임베딩에 관한 것뿐만 아니라 자유 형식 주석은 자유 형식으로 유지되어야한다는 사실을 나타내는 +0.5 ;-) –
구체적인 규칙은 없습니다. 주석은 주석이며 무시되고 버려 지므로 원하는 방식으로 주석을 형성 할 수 있습니다.
예를 들어 의견을 해석하는 프로그램 (예 : doxygen)을 사용하려면 해당 프로그램의 참조를 봐야합니다.
코드에서 문서화를 추출하는 경우 해당 주석 형식을 따라야합니다. 예를 들어 DOxygen을 사용하므로 Doxygen 규칙을 따라야합니다.
설명서에 대한 의견을 추출하지 않으려면 간단한 코딩 방법을 적용해야합니다.
javadoc과 비슷한 문서 생성을 원하십니까? – zdan
나는 C++ 코드를 어떻게 문서화 할 것인가에 관한 규칙이 있다고 생각했다. Java 코드에 대한 예제를 제공 한 것과 같습니다. – ucas
또 다른 옵션은'size' 대신에'number_of_rooms'을 매개 변수 이름으로 사용하는 것입니다. 그것이 무엇인지 설명하지 못하게합니다. –