Check class names for wording issues

Docs > Datadog Security > Code Security > Static Code Analysis (SAST) > SAST Rules > Check class names for wording issues

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Metadata

ID: ruby-inclusive/class-definition

Language: Ruby

Severity: Notice

Category: Best Practices

Description

In Ruby, class names should be meaningful and concise, and follow the naming conventions. Avoid using terms that might be considered offensive, derogatory, or otherwise inappropriate. Instead, use terminology that accurately represents the functionality or role of the class.

For instance, instead of using MasterClass, consider using PrimaryClass, MainClass, or another appropriate term that doesn’t have potentially negative connotations.

Non-Compliant Code Examples

class MasterClass
    def my_method
    end
end

Compliant Code Examples

class PrimaryClass
    def my_method
    end
end