Atomineer에서 규칙 수정

Question

내 주석 블록에서 @remarks 및 @ingroup을 사용하고 있지만 Atomineer를 실행하면 삭제 표시가 유지되며이를 수행하지 못하게됩니다. .XML 구성 파일에서 규칙을 수정하는 방법을 살펴 봤지만 분명히 뭔가 빠져 있습니다. Atomineer으로 처리하기 전에

예 : Atomineer로 처리 한 후

//------------------------------------------------------------------------------------- 
/// @copydoc interface_Result 
///   
/// @ingroup platform_implementation module_core 
//------------------------------------------------------------------------------------- 

예 :

//------------------------------------------------------------------------------------ 
/// @copydoc interface_Result. 
/// 
/// ### ingroup platform_implementation module_core. 
//------------------------------------------------------------------------------------ 

문서는 말한다 : "설정하십시오 Doxygen을 또는 DocXML는에서 '법적'항목을 표시 할 때 템플릿 새로운 주석 형식 및 새로운 주석 블록 내에서의 정렬 방법 (예 : param -> param)은 이전 스타일과 새 형식 모두에서 동일한 태그를 가진 항목은 자동으로 '변환'됩니다 (새 스타일로 다시 포맷 됨) consi가 아닌 모든 항목 AtomineerUtils의 'legal'은 '### 접두어로 삭제됨'으로 표시됩니다. "

모든 포인터 또는 아이디어를 주시면 감사하겠습니다. 이 일을 그만두기 위해 정말로 필요합니다.

감사합니다.

Answer 1

은 Visual Studio에서

,

• 도구로 이동 (나는 Atomineer Pro Documentation의 저자 해요)> Atomineer> Atomineer 옵션 ... "고급 사용자 지정"탭
-
• 스위치
• 블록 템플릿 - Doxygen 버튼을 클릭하십시오.

사용자 정의 할 수있는 템플릿이 포함 된 편집기 (메모장)가 열립니다.

템플릿은 XML 기반이며, 그들은 Atomineer에 지시 :

항목이 법적 (필수 또는 선택)입니다

• . 언급되지 않은 항목은 모두 "불법"으로 간주되어 삭제됩니다.
• 업데이트 주석이 생성 될 때 항목이 정렬되는 순서/주석 블록에 추가 공백 (빈 줄)을 넣어
• 문장 보정을위한/비활성화 활성화 여부와 같은 몇 가지 다른 것들 각 항목 등

Atomineer가 문서화 할 수있는 각기 다른 유형의 코드 요소에 대한 템플릿이 있으므로 문서의 각 부분이 어떻게 보이는지 정확하게 제어 할 수 있지만 복사해야 함을 의미합니다 새 요소를 각 템플리트에 붙여 넣으십시오.

예를 들어, 여기에 Doxygen을 방법 주석의 기본 템플릿입니다 :

<method> 
     <prototype _punctuate="false" /> 
     <_ /> 
     <summary /> 
     <_ /> 
     <author _punctuate="false">%user%</author> 
     <date _punctuate="false">%date%</date> 
     <_ /> 
     <exception /> 
     <_ /> 
     <param /> 
     <_ /> 
     <returns /> 
     <_ /> 
     <sa _punctuate="false" _optional="true" /> 
    </method> 

각 XML 요소 (선)이에서 주석에 하나의 항목에 대해 설명합니다. 예 : XML 태그 <param/>은 @param 항목이 최종 설명 블록에 배치되는 위치와 일치합니다.특수 요소 <_/>은 빈 줄을 삽입해야하는 위치를 나타내는 데 사용됩니다. (프로토 타입은 프로토 타입/선언 @fn, @class 등을 삽입 할 위치를 알려주는 특별한 doxygen 중 하나임)

및 @remarks을 Atomineer 주석에 삽입하려면 해당 위치에 항목을 추가하기 만하면됩니다. 그것은 다음과 같이 주석에 표시 할 : 당신은 내가 추가 한 예 요소는 그들의 속성 _optional="true"을 가지고 볼 수

<method> 
     <prototype _punctuate="false" /> 
     <ingroup _optional="true" /> 
     <_ /> 
     <summary /> 
     <_ /> 
     <remarks _optional="true" /> 
     <_ /> 
     <author _punctuate="false">%user%</author> 
     ... 
    </method> 

. 이 기능이 없으면 Atomineer는 모든 설명에 항목을 추가합니다 (필수 항목). true으로 설정하면 Atomineer가 입력 한 이이 아니지만 직접 입력하면 의사 메모를 업데이트 할 때 Atomineer가이를 보존합니다.

나는 이것이 얼마나 복잡한가에 대해 사과하지만, 때로는 몇 분의 설정이 필요할지라도 모든 사람들이 원하는 것을 얻을 수있는 유연한 시스템입니다. 시간이들 때마다이 프로세스를보다 쉽게하기 위해 향상된 구성 도구와 자습서를 작성하고 있습니다. 그래도 설정을 마치면 많은 행복한 해가 될 것입니다 .-)

템플릿에 대한 더 많은 문서와 그 안에 할 수있는 다른 것들이 here입니다.

추가 질문 사항이 있으면 언제든지 Atomineer 웹 사이트의 모든 페이지 하단에있는 지원 이메일에 내용을 기재하십시오. 나는 언제나 도와 드리겠습니다.