3
레일 프로젝트에 YARD을 사용하고 있는데 Rails 모델에서 상속 된/런타임 메소드를 문서화하는 방법에 대해 궁금해하십니까? 예를 들어 User 모델에서 first_name 속성의 존재를 문서화합니다.레일즈 모델 내부의 암시 적 메서드를 어떻게 문서화 할 수 있습니까?
A
답변
0
IMHO 할 수는 없습니다.
문제는 이러한 메서드가 실제로 "존재하지"않는다는 것입니다. 런타임에 method_missing 후크를 통해 처음 생성 될 때 "즉시 만들어집니다".
기타 문서 생성 시스템에는 "암시 적"방법을 선언하는 방법이 있습니다. 예를 들어 NaturalDocs에는 function keyword이 있으며 주석에만있는 함수를 만들 수 있습니다. 나는 야드에 익숙하지 않지만 비슷한 기능을 갖고 있지는 않은 것으로 보인다.
행운을 빈다.
http://gilesbowkett.blogspot.com/2008/02/activerecord-ruby2ruby-this-is-where.html Ruby2Ruby가 도움이 될 수 있지만 자신 만의 rdoc 생성 워크 플로를 만들어야합니다. 'gem rdoc your_project'는 당신이 rdoc을 포기하지 않으면 작동하지 않을 가능성이 큽니다. –