File: Tags Overview — Documentation for yard (0.9.36)
Tags Overview Tags represent meta-data as well as behavioural data that can be added to documentation through the @tag style syntax. As mentioned, there are two basic types of tags in YARD, "meta-data tags" and "behavioural tags", the latter is more often known as "directives". These two tag types can be visually identified by their prefix. Meta-data tags have a @ prefix, while directives have a p
GitHub - AaronC81/sord: Convert YARD docs to Sorbet RBI and Ruby 3/Steep RBS files
Sord is a Sorbet and YARD crossover. It can automatically generate RBI and RBS type signature files by looking at the types specified in YARD documentation comments. If your project is already YARD documented, then this can generate most of the type signatures you need! Sord is the perfect way to jump-start the adoption of types in your project, whether you plan to use Sorbet's RBI format or Ruby
RubyでYARD定義を使って実行時にメソッド引数と戻り値の型チェックを試みる
RubyでYARD定義を使って実行時にメソッド引数と戻り値の型チェックを試みる June 3, 2018 （Ruby のカンファレンスの度に、毎度話題になる？） Ruby に型が欲しい件ですが、個人的な見解を書いておこうと思います。ちなみに私は RubyKaigi 2018 に参加しておりません。Twitterのタイムラインでの賑わいを見ていただけです。 最近、Swift を触っててそのコンパイルの重さにうんざりしているので、 型推論 は現代のマシンスペックでは基本的に辛いと思っています（カフェでノマドコーディングしたいので）。またメタプログラミングし放題の Ruby に導入するのは困難という認識です。 では、どういうときに 型定義 が欲しくなるのか考えてみます。 コードを書いて実行して確認というトライアンドエラーを減らしたい、実行前にエラーをなるべく洗い出したい。 型定義起因による補完を
File: README — Documentation by YARD 0.9.20
Oga NOTE: my spare time is limited which means I am unable to dedicate a lot of time on Oga. If you’re interested in contributing to FOSS, please take a look at the open issues and submit a pull request to address them where possible. Oga is an XML/HTML parser written in Ruby. It provides an easy to use API for parsing, modifying and querying documents (using XPath expressions). Oga does not requi
File: Tags Overview — Documentation for yard (0.9.36)
Tags Overview Tags represent meta-data as well as behavioural data that can be added to documentation through the @tag style syntax. As mentioned, there are two basic types of tags in YARD, "meta-data tags" and "behavioural tags", the latter is more often known as "directives". These two tag types can be visually identified by their prefix. Meta-data tags have a @ prefix, while directives have a p
2013年新学期にRubyを始めるエンジニアが読むべきサイトまとめ
初心者ぺちぱーがRubyのコードを書くに当たって、大変勉強になったサイト、これから読んでおきたいドキュメントを紹介する。 Index Ruby入門・チュートリアル Ruby reference Ruby 2.0の新機能 Rubyコーディング規約 Ruby関連の情報 Ruby tool Ruby ブログ rbenv & ruby-build Gem Bundler irb pry RDoc YARD RSpec Cucumber SimpleCov ruby-prof Rake Rack Rack対応HTTPサーバー Sinatra Ruby on Rails Rails 4.0の新機能 Ruby入門・チュートリアル Rubyを始めるときに、入り口になるところ。他言語文化圏からの移民の人達は第1章 Ruby言語ミニマムから読み始めると、256倍ぐらい理解が早くなると思う。 第1章 Ruby言
YARD - A Ruby Documentation Tool
What Is YARD? YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Above is a highlight of the some of YARD's notable features. And of course YARD comes with muc
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
YARD cheatsheet
Best practice to mark deprecated code in Ruby?
GitHub - south37/yard2steep: Generate steep type definition file from yard annotation
File: Tags Overview — Documentation for yard (0.9.9)
Headersroot: headers — Documentation by YARD 0.9.20
はてなブログ | 無料ブログを作成しよう
Rails/Rubyドキュメントをキレイに生成するYARD、早見表付き！ 