SID has no descriptive comment Open
class SID
- Read upRead up
- Exclude checks
Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.
Example
Given
class Dummy
# Do things...
end
Reek would emit the following warning:
test.rb -- 1 warning:
[1]:Dummy has no descriptive comment (IrresponsibleModule)
Fixing this is simple - just an explaining comment:
# The Dummy class is responsible for ...
class Dummy
# Do things...
end
Missing top-level class documentation comment. Open
class SID
- Read upRead up
- Exclude checks
This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.
The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.
Example:
# bad
class Person
# ...
end
# good
# Description/Explanation of Person class
class Person
# ...
end
Use underscores(_) as decimal mark and separate every 3 digits with them. Open
def initialize(buffersize = 16384, background_noise = 0.0005)
- Read upRead up
- Exclude checks
This cop checks for big numeric literals without _ between groups of digits in them.
Example:
# bad
1000000
1_00_000
1_0000
# good
1_000_000
1000
# good unless Strict is set
10_000_00 # typical representation of $10,000 in cents