yard-documentation

YARD documentation for Ruby public APIs is enforced by applying a post-implementation governance gate mandating English-language @param, @return, and @example tags before PR completion. This ensures consistent inline documentation across Rails and Ruby projects.

Required YARD tags for Ruby public methods include @param, @return, @raise, and @example blocks. These comprehensive English-language tags ensure clear public interfaces and enable easier code maintenance and reliable API docs generation.

YARD documentation applies to Rails projects by enforcing consistent English-language YARD blocks across classes and methods. It supports global collaboration and tooling by mandating English descriptions and comprehensive inline documentation for public APIs.

YARD documentation for Ruby code is needed when maintaining clear public APIs requiring consistent inline documentation and generated API references. It enables reliable API docs generation and supports global collaboration through English-language descriptions.

Documenting Ruby APIs with YARD is best done by immediately adding English-language YARD tags to every public class and method after implementing changes, followed by a HARD-GATE check before PR completion to ensure comprehensive @param, @return, and @example blocks.