Ответ 1
Вы можете указать все недокументированные объекты (и их расположение файлов) с помощью параметра --list-undoc.
yard stats --list-undoc
или даже
yard --list-undoc
Как я могу перечислить недокументированные модули/классы/константы/методы с помощью yardoc?
У меня есть небольшая библиотека кода, которую я документирую с помощью YARD. Когда я запускаю команду yardoc, она сообщает мне:
Files: 40
Modules: 14 ( 0 undocumented)
Classes: 39 ( 0 undocumented)
Constants: 21 ( 4 undocumented)
Methods: 239 ( 31 undocumented)
88.82% documented
Вместо того чтобы пробираться через весь мой код, чтобы найти недокументированные константы и методы, я хочу, чтобы он просто перечислял недокументированные элементы. Кто-нибудь знает, как это сделать?
Ответы
Ответ 2
Это тоже смутило меня. Опция --list-undoc фактически определена в команде stats. Кроме того, команда yard, а не yardoc, которая является сокращением для yard doc.
yard stats --list-undoc