appleDoc 및 /// TODO 사용 : 의견

Question

저는 AppleDoc을 사용하여 문서를 생성하는 프로젝트를 진행하고 있습니다. 나는 내 코드의 예를 몇 가지 TODO 주석을 추가 할 :

///TODO: Some stuff to be done 
-(void)myMethod:(id)myParam{ 
    [self doSomeFancyStuff]; 
} 

문제는 내 프로젝트 문서를 생성 할 때 나는 귀찮은 경고를 얻을 논문이다 :

/사용자/ME/트렁크/MyProject를/MyProject를/SRC/MyClass.m : 119 : MyClass.m@119 : 누락 된 매개 변수 '하여 myParam' 설명 - [MyClass에 MyMethod라는 :]

분명히

내 TODO 주석을 제거 할 수 하지만 나 내 아름다움이 넘치는 의사와 함께 지내고 싶어. 아무도 그것을 달성하는 방법을 알고 있습니까?

Answer 1

/// 블록을 추가하면 Appledoc/Doxygen 문서 블록이 실행되고 기능이 문서화 된 것으로 표시됩니다. 의사 생성기는 매개 변수를 문서화하지 않았기 때문에 블록을 검사하여 불완전하다고보고합니다.

1. 이 /// @param myParam brief explanation of what it is
2. 사용 // 대신 ///와 다른 행을 추가

   당신은이 개 솔루션을 가지고있다.