/***/와 같은 C 코멘트에 '<'가 필요한 이유는 무엇입니까?

/***/와 같은 C 코멘트에 '<'가 필요한 이유는 무엇입니까?

팀 C-code 가이드라인에는 다음과 같은 코멘트에 '<'를 붙이는 것이 좋다고 기재되어 있습니다.

#define MAX_PACK_ITEM_NUM 50  /**<  max number of item */

이 '<'의 진짜 용도는 무엇일까요?

을 위한 방법이다.doxygen파일/파일/연합/클래스/엔넘 구성원에 대한 문서를 생성합니다.이 마커를 사용하면 각 멤버 뒤에 코멘트를 붙일 수 있기 때문에 번잡함을 줄일 수 있습니다.자세한 내용은 여기를 참조하십시오.

다른 사람들이 답했듯이, 이것은 아마도 독시겐을 위한 코멘트일 것입니다.코멘트를 해석할 때 doxygen에는 다음과 같은 특별한 규칙이 있습니다.

• 로 시작하는 평범한 코멘트/*doxygen에 의해 무시됩니다.
• 로 시작하는 코멘트/**는 소스 코드의 코멘트 후 다음 항목의 문서로 취급됩니다.
• 로 시작하는 코멘트/**<는 소스 코드의 코멘트 직전에 아이템의 문서로서 취급됩니다.

문서화는 대부분 문서화된 항목 위에 배치됩니다(예: 기능).단, 예를 들어 다음과 같은 경우#define대신 맨 끝에 문서를 배치하는 것이 타당하며, 이 경우/**<마커가 필요합니다.

선언/정의 후 멤버 코멘트를 하기 위한 Doxygen 구문입니다.

당신네 팀은 자동 문서 도구를 사용하여/**<(예: Doxygen).

언급URL : https://stackoverflow.com/questions/7329566/why-does-a-c-comment-like-need