Download README.md (YARD)

Other Useful Business Software

Go from Code to Production URL in Seconds

Cloud Run deploys apps in any language instantly. Scales to zero. Pay only when code runs.

Skip the Kubernetes configs. Cloud Run handles HTTPS, scaling, and infrastructure automatically. Two million requests free per month.

Try it free

Fully Managed MySQL, PostgreSQL, and SQL Server

Automatic backups, patching, replication, and failover. Focus on your app, not your database.

Cloud SQL handles your database ops end to end, so you can focus on your app.

Try Free

Gemini 3 and 200+ AI Models on One Platform

Access Google's best plus Claude, Llama, and Gemma. Fine-tune and deploy from one console.

Build generative AI apps with Vertex AI. Switch between models without switching platforms.

Start Free

Save Up to 91% on Cloud Compute With Spot VMs

Automatic sustained-use discounts. One free VM per month. No negotiation needed.

Run batch jobs at 60-91% off with Spot VMs. Long-running workloads get automatic discounts with sustained use.

Try Free

Try Google Cloud Risk-Free With $300 in Credit

No hidden charges. No surprise bills. Cancel anytime.

Use your credit across every product. Compute, storage, AI, analytics. When it runs out, 20+ products stay free. You only pay when you choose to.

Start Free

YARD Overview

YARD is a Ruby Documentation tool. The Y stands for "Yay!"

With the new dynamic documentation server in YARD 0.6, you can now see exactly what YARD sees as you document your code. Simply type yard server, reload to have your project watch for changes in your codebase everytime you refresh the page. With this functionality, you almost have no excuse not to write documentation! You can write all kinds of extensions in YARD, including ones that can understand all of the dynamic magic your framework does in its own little Domain Specific Languages (DSLs). Most importantly, it's really easy to do! There are already plugins that support frameworks like RSpec, DataMapper, Sinatra, and support for others are in the works. YARD is the only Ruby documentation tool that supports storing metadata alongside your documentation. This metadata can be used to create consistent documentation in any format you wish. YARD also comes with a powerful templating system to quickly modify existing templates.

Additional Details for YARD

Programming Language

Ruby

Registered

2022-09-07

Last Updated

2025-12-05

Maintainers

sf-editor1

Keep Me Updated!

Get an email when this software releases a new version (no other emails will be sent). Get newsletters and notices that include site news, special offers and exclusive discounts about IT products & services.

I understand by clicking on "Subscribe" below I am agreeing to the SourceForge Terms of Use and the Privacy Policy which describe how we use and share your data. I agree to receive these communications from SourceForge.net. I understand that I can withdraw my consent at anytime.

JavaScript is required for this form.

YARD