Почему “: nodoc”: синтаксис необходим?
Я склонен проявлять "подход" ответвления выпуска. Соединительная линия энергозависима. Однажды выпускают подходы времени, я заставил бы выпуск перейти, который я буду рассматривать более осторожно. Когда это наконец сделано, я маркировал бы/отметил бы состояние репозитория, таким образом, я буду знать, что "чиновник" выпустил версию.
я понимаю, что существуют другие способы сделать это - это - просто способ, которым я сделал его в прошлом.
1 ответ
It is not necessary. If applied to a class, it just suppresses documentation (rdoc) for all the methods in the Class extension. Described in Programming Ruby as:
:nodoc: - Не включайте этот элемент в документация. Для занятий и модули, методы, псевдонимы, константы и атрибуты напрямую внутри затронутого класса или модуля также будет исключен из документация. Однако по умолчанию модули и классы в этом классе или модуль будет задокументирован.