Skip to content

Files

Latest commit

 

History

History
84 lines (60 loc) · 842 Bytes

Layout-EmptyComment.md

File metadata and controls

84 lines (60 loc) · 842 Bytes

Pattern: Empty code comment

Issue: -

Description

This rule checks for empty comments.

Examples

# bad

#
class Foo
end

# good

#
# Description of `Foo` class.
#
class Foo
end

AllowBorderComment: true (default)

# good

def foo
end

#################

def bar
end

AllowBorderComment: false

# bad

def foo
end

#################

def bar
end

AllowMarginComment: true (default)

# good

#
# Description of `Foo` class.
#
class Foo
end

AllowMarginComment: false

# bad

#
# Description of `Foo` class.
#
class Foo
end

Default configuration

Attribute Value
AllowBorderComment true
AllowMarginComment true

Further Reading