YARD is a Ruby Documentation tool. The Y stands for "Yay!" (by lsegal)

YARD Alternatives

Similar projects and alternatives to YARD

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a better YARD alternative or higher similarity.

YARD reviews and mentions

Posts with mentions or reviews of YARD. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2023-05-08.
  • Programming types and mindsets
    4 projects | reddit.com/r/ruby | 8 May 2023
    I still just document everything using YARD and focus on designing really obvious Object Models and of course write tests. I have tried using sord to convert my YARD type annotations to RBS or RBI, but you still have to fill in missing bits, then use steep and somehow load in RBS/RBI files for other gems and stdlib, and it's just an uphill battle since Ruby is dynamically typed by default. Obviously Dynamic Typing lends itself more to Dynamic Languages, where you can call an arbitrary method and let the language VM figure it out at runtime. Static or Strong Typing lends itself better to compiled languages where everything needs to be resolved at compile time and converted into object code. If I need to work in a compiled language, then I'll use Crystal, which also supports type inference. TypeScript's type syntax is quite nice, but I tend to avoid writing massive JavaScript code bases where a Type Checker helps catch subtle bugs, and instead prefer sticking to minimal amounts of vanilla JavaScriot in order to keep complexity low and not overwhelm the browser.
  • How do you document your code?
    3 projects | reddit.com/r/rails | 17 Jan 2023
    I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.
  • The right is on the left
    3 projects | reddit.com/r/technicallythetruth | 13 Jan 2023
    That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).
  • #buildinpublic, issue 1: building API documentation browser for command line
    2 projects | dev.to | 15 Oct 2022
    My first assumption was, that I should be able to generate markdown from the source. Same ruby and rails does now, but only tweaking a couple of parameters to generate .md files instead. YARD is being used for that and it supports any markup rdoc or yard.
  • The Why and How of Yardoc
    6 projects | dev.to | 17 Mar 2022
    I’ve long used the YARD format and chose to use that as my documentation syntax. I suppose I didn’t check with anyone on this decision and slowly started adding documentation. I want to use this post to synthesize my implicit decision and the benefits of using Yard as the documentation format.
  • Graphic representation of class / module inheritance in Rails?
    2 projects | reddit.com/r/rails | 26 Feb 2022
    That said, YARD is a ruby documentation tool that has a yard graph command you can use to dump a UML graph for your app into a .dot file, which can be used with lots of different graphing tools (usually graphviz but there are a bunch of online tools and open source projects that can visualize them for you).
  • What is your development setup (IDE, gems, library, ci/cd etc) for RoR/non-RoR applications development ?
    8 projects | reddit.com/r/ruby | 10 Feb 2022
    Linux (Fedora), gvim (because it opens a new window instead of taking up yet-another-terminal-tab), fluxbox (because it has awesomely configurable hot-key support), dotfiles, chruby + ruby-install (with rubies installed into /opt/rubies), bundler + rspec + yard + rubygems-tasks + gemspec_yml + GitHub Actions on all of my Ruby projects.
  • Best services and/or gems for automated generation of documentation, unit tests, and useful things of this nature
    2 projects | reddit.com/r/ruby | 16 Jan 2022
    If you're looking to generate docs from source, there's always the yard gem. If you want a diagram of your Rails models you might try railroady. Neither will create comments in your code, which is what I understand mintlify.com is doing for you.
  • High functionality but decreasing popularity
    4 projects | reddit.com/r/ruby | 27 Dec 2021
    Please fellow Rubyists, document your methods with YARDoc tags. It takes a few seconds, makes your code easier to navigate, and causes you to double-check your interfaces. You can even document abstract methods (ex: @abstract), method groups (ex: @group), named examples (ex: @example Title here, code below), public/semipublic/private APIs (ex: @api public|semipublic|private), when a method/class/module was added (ex: @since 1.2.0), documenting keyword argument splats (ex: @option kwargs [Integer] :count), and when a method can accept any type of Object that responds to a specific method (ex: @param [#foo] arg).
  • Haiti v1.2.3 release
    2 projects | reddit.com/r/Rawsec | 15 Dec 2021
    Update to yard v0.9.27 Move from Redcarpet to CommonMarker markdown provider
  • A note from our sponsor - CodiumAI
    codium.ai | 29 May 2023
    Get non-trivial tests (and trivial, too!) suggested right inside your IDE, so you can code smart, create more value, and stay confident when you push. Learn more →


Basic YARD repo stats
9 days ago

lsegal/yard is an open source project licensed under MIT License which is an OSI approved license.

The primary programming language of YARD is Ruby.

Clean code begins in your IDE with SonarLint
Up your coding game and discover issues early. SonarLint is a free plugin that helps you find & fix bugs and security issues from the moment you start writing code. Install from your favorite IDE marketplace today.