Categories: None [Edit]
yard-heuristics
YARD-Heuristics
YARD-Heuristics heuristically determines types of parameters and return
values for YARD documentation that doesnΓÇÖt explicitly document it. This
allows you to write documentation that isnΓÇÖt adorned with ΓÇ£obviousΓÇ¥ types,
but still get that information into the output. It also lets you
nice-looking references to parameters and have them be marked up
appropriately in HTML output.
§ Heuristics
The following sections list the various heuristics that YARD-Heuristics
apply for determining types of parameters and return values.
Note that for all heuristics, a type will only be added if none already
exists.
§ Parameter Named “other”
A parameter named ΓÇ£otherΓÇ¥ has the same type as the receiver. This turns
class Point
def ==(other)
into
class Point
# @param [Point] other
def ==(other)
§ Parameter Types Derived by Parameter Name
Parameters to a method with names in the following table has the type
listed on the same row.
| Name | Type |
|--------+-----------|
| index | [Integer] |
| object | [Object] |
| range | [Range] |
| string | [String] |
Thus
class Point
def x_inside?(range)
becomes
class Point
# @param [Range] range
def x_inside?(range)
§ Block Parameters
If the last parameter to a methodΓÇÖs name begins with ΓÇÿ&ΓÇÖ it has the type
[Proc].
class Method
def initialize(&block)
becomes
class Method
# @param [Block] block
def initialize(&block)
§ Return Types by Method Name
For the return type of a method with less than two ‹@return› tags, the
method name is lookup up in the following table and has the type listed on
the same row. For the “type” “self or type”, if a ‹@param› tag exists with
the name ΓÇ£otherΓÇ¥, the type of the ...
Total
Ranking: 50,967 of 180,702
Downloads: 18,743
Daily
Ranking: 20,645 of 180,689
Downloads: 31
Downloads Trends
Ranking Trends
Num of Versions Trends
Popular Versions (Major)
Popular Versions (Major.Minor)
Depended by
Rank | Downloads | Name |
---|---|---|
22,196 | 57,241 | inventory |
32,802 | 33,486 | lookout |
34,128 | 31,704 | inventory-rake |
34,404 | 31,370 | inventory-rake-tasks-yard |
39,882 | 25,925 | value |
60,992 | 14,717 | lookout-rake |
66,622 | 12,983 | ame |
78,295 | 10,261 | u |
98,582 | 7,103 | lookout-rack |
Depends on
Rank | Downloads | Name |
---|---|---|
223 | 143,611,496 | yard |
22,196 | 57,241 | inventory |
32,802 | 33,486 | lookout |
34,128 | 31,704 | inventory-rake |
60,992 | 14,717 | lookout-rake |
Owners
# | Gravatar | Handle |
---|---|---|
1 | now |