Skip to content

Latest commit

 

History

History
1993 lines (1229 loc) · 48 KB

readability-identifier-naming.rst

File metadata and controls

1993 lines (1229 loc) · 48 KB

clang-tidy - readability-identifier-naming

readability-identifier-naming

Checks for identifiers naming style mismatch.

This check will try to enforce coding guidelines on the identifiers naming. It supports one of the following casing types and tries to convert from one to another if a mismatch is detected

Casing types include:

  • lower_case,
  • UPPER_CASE,
  • camelBack,
  • CamelCase,
  • camel_Snake_Back,
  • Camel_Snake_Case,
  • aNy_CasE.

It also supports a fixed prefix and suffix that will be prepended or appended to the identifiers, regardless of the casing.

Many configuration options are available, in order to be able to create different rules for different kinds of identifiers. In general, the rules are falling back to a more generic rule if the specific case is not configured.

The naming of virtual methods is reported where they occur in the base class, but not where they are overridden, as it can't be fixed locally there. This also applies for pseudo-override patterns like CRTP.

Options

The following options are describe below:

  • AbstractClassCase, AbstractClassPrefix, AbstractClassSuffix
  • AggressiveDependentMemberLookup
  • ClassCase, ClassPrefix, ClassSuffix
  • ClassConstantCase, ClassConstantPrefix, ClassConstantSuffix
  • ClassMemberCase, ClassMemberPrefix, ClassMemberSuffix
  • ClassMethodCase, ClassMethodPrefix, ClassMethodSuffix
  • ConstantCase, ConstantPrefix, ConstantSuffix
  • ConstantMemberCase, ConstantMemberPrefix, ConstantMemberSuffix
  • ConstantParameterCase, ConstantParameterPrefix, ConstantParameterSuffix
  • ConstantPointerParameterCase, ConstantPointerParameterPrefix, ConstantPointerParameterSuffix
  • ConstexprFunctionCase, ConstexprFunctionPrefix, ConstexprFunctionSuffix
  • ConstexprMethodCase, ConstexprMethodPrefix, ConstexprMethodSuffix
  • ConstexprVariableCase, ConstexprVariablePrefix, ConstexprVariableSuffix
  • EnumCase, EnumPrefix, EnumSuffix
  • EnumConstantCase, EnumConstantPrefix, EnumConstantSuffix
  • FunctionCase, FunctionPrefix, FunctionSuffix
  • GlobalConstantCase, GlobalConstantPrefix, GlobalConstantSuffix
  • GlobalConstantPointerCase, GlobalConstantPointerPrefix, GlobalConstantPointerSuffix
  • GlobalFunctionCase, GlobalFunctionPrefix, GlobalFunctionSuffix
  • GlobalPointerCase, GlobalPointerPrefix, GlobalPointerSuffix
  • GlobalVariableCase, GlobalVariablePrefix, GlobalVariableSuffix
  • IgnoreMainLikeFunctions
  • InlineNamespaceCase, InlineNamespacePrefix, InlineNamespaceSuffix
  • LocalConstantCase, LocalConstantPrefix, LocalConstantSuffix
  • LocalConstantPointerCase, LocalConstantPointerPrefix, LocalConstantPointerSuffix
  • LocalPointerCase, LocalPointerPrefix, LocalPointerSuffix
  • LocalVariableCase, LocalVariablePrefix, LocalVariableSuffix
  • MemberCase, MemberPrefix, MemberSuffix
  • MethodCase, MethodPrefix, MethodSuffix
  • NamespaceCase, NamespacePrefix, NamespaceSuffix
  • ParameterCase, ParameterPrefix, ParameterSuffix
  • ParameterPackCase, ParameterPackPrefix, ParameterPackSuffix
  • PointerParameterCase, PointerParameterPrefix, PointerParameterSuffix
  • PrivateMemberCase, PrivateMemberPrefix, PrivateMemberSuffix
  • PrivateMethodCase, PrivateMethodPrefix, PrivateMethodSuffix
  • ProtectedMemberCase, ProtectedMemberPrefix, ProtectedMemberSuffix
  • ProtectedMethodCase, ProtectedMethodPrefix, ProtectedMethodSuffix
  • PublicMemberCase, PublicMemberPrefix, PublicMemberSuffix
  • PublicMethodCase, PublicMethodPrefix, PublicMethodSuffix
  • StaticConstantCase, StaticConstantPrefix, StaticConstantSuffix
  • StaticVariableCase, StaticVariablePrefix, StaticVariableSuffix
  • StructCase, StructPrefix, StructSuffix
  • TemplateParameterCase, TemplateParameterPrefix, TemplateParameterSuffix
  • TemplateTemplateParameterCase, TemplateTemplateParameterPrefix, TemplateTemplateParameterSuffix
  • TypeAliasCase, TypeAliasPrefix, TypeAliasSuffix
  • TypedefCase, TypedefPrefix, TypedefSuffix
  • TypeTemplateParameterCase, TypeTemplateParameterPrefix, TypeTemplateParameterSuffix
  • UnionCase, UnionPrefix, UnionSuffix
  • ValueTemplateParameterCase, ValueTemplateParameterPrefix, ValueTemplateParameterSuffix
  • VariableCase, VariablePrefix, VariableSuffix
  • VirtualMethodCase, VirtualMethodPrefix, VirtualMethodSuffix

AbstractClassCase

When defined, the check will ensure abstract class names conform to the selected casing.

AbstractClassPrefix

When defined, the check will ensure abstract class names will add the prefixed with the given value (regardless of casing).

AbstractClassSuffix

When defined, the check will ensure abstract class names will add the suffix with the given value (regardless of casing).

For example using values of:

  • AbstractClassCase of lower_case
  • AbstractClassPrefix of pre_
  • AbstractClassSuffix of _post

Identifies and/or transforms abstract class names as follows:

Before:

After:

AggressiveDependentMemberLookup

When set to 1 the check will look in dependent base classes for dependent member references that need changing. This can lead to errors with template specializations so the default value is 0.

For example using values of:

  • ClassMemberCase of lower_case

Before:

After if AggressiveDependentMemberLookup is 0:

After if AggressiveDependentMemberLookup is 1:

ClassCase

When defined, the check will ensure class names conform to the selected casing.

ClassPrefix

When defined, the check will ensure class names will add the prefixed with the given value (regardless of casing).

ClassSuffix

When defined, the check will ensure class names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ClassCase of lower_case
  • ClassPrefix of pre_
  • ClassSuffix of _post

Identifies and/or transforms class names as follows:

Before:

After:

ClassConstantCase

When defined, the check will ensure class constant names conform to the selected casing.

ClassConstantPrefix

When defined, the check will ensure class constant names will add the prefixed with the given value (regardless of casing).

ClassConstantSuffix

When defined, the check will ensure class constant names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ClassConstantCase of lower_case
  • ClassConstantPrefix of pre_
  • ClassConstantSuffix of _post

Identifies and/or transforms class constant names as follows:

Before:

After:

ClassMemberCase

When defined, the check will ensure class member names conform to the selected casing.

ClassMemberPrefix

When defined, the check will ensure class member names will add the prefixed with the given value (regardless of casing).

ClassMemberSuffix

When defined, the check will ensure class member names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ClassMemberCase of lower_case
  • ClassMemberPrefix of pre_
  • ClassMemberSuffix of _post

Identifies and/or transforms class member names as follows:

Before:

After:

ClassMethodCase

When defined, the check will ensure class method names conform to the selected casing.

ClassMethodPrefix

When defined, the check will ensure class method names will add the prefixed with the given value (regardless of casing).

ClassMethodSuffix

When defined, the check will ensure class method names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ClassMethodCase of lower_case
  • ClassMethodPrefix of pre_
  • ClassMethodSuffix of _post

Identifies and/or transforms class method names as follows:

Before:

After:

ConstantCase

When defined, the check will ensure constant names conform to the selected casing.

ConstantPrefix

When defined, the check will ensure constant names will add the prefixed with the given value (regardless of casing).

ConstantSuffix

When defined, the check will ensure constant names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ConstantCase of lower_case
  • ConstantPrefix of pre_
  • ConstantSuffix of _post

Identifies and/or transforms constant names as follows:

Before:

After:

ConstantMemberCase

When defined, the check will ensure constant member names conform to the selected casing.

ConstantMemberPrefix

When defined, the check will ensure constant member names will add the prefixed with the given value (regardless of casing).

ConstantMemberSuffix

When defined, the check will ensure constant member names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ConstantMemberCase of lower_case
  • ConstantMemberPrefix of pre_
  • ConstantMemberSuffix of _post

Identifies and/or transforms constant member names as follows:

Before:

After:

ConstantParameterCase

When defined, the check will ensure constant parameter names conform to the selected casing.

ConstantParameterPrefix

When defined, the check will ensure constant parameter names will add the prefixed with the given value (regardless of casing).

ConstantParameterSuffix

When defined, the check will ensure constant parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ConstantParameterCase of lower_case
  • ConstantParameterPrefix of pre_
  • ConstantParameterSuffix of _post

Identifies and/or transforms constant parameter names as follows:

Before:

After:

ConstantPointerParameterCase

When defined, the check will ensure constant pointer parameter names conform to the selected casing.

ConstantPointerParameterPrefix

When defined, the check will ensure constant pointer parameter names will add the prefixed with the given value (regardless of casing).

ConstantPointerParameterSuffix

When defined, the check will ensure constant pointer parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ConstantPointerParameterCase of lower_case
  • ConstantPointerParameterPrefix of pre_
  • ConstantPointerParameterSuffix of _post

Identifies and/or transforms constant pointer parameter names as follows:

Before:

After:

ConstexprFunctionCase

When defined, the check will ensure constexpr function names conform to the selected casing.

ConstexprFunctionPrefix

When defined, the check will ensure constexpr function names will add the prefixed with the given value (regardless of casing).

ConstexprFunctionSuffix

When defined, the check will ensure constexpr function names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ConstexprFunctionCase of lower_case
  • ConstexprFunctionPrefix of pre_
  • ConstexprFunctionSuffix of _post

Identifies and/or transforms constexpr function names as follows:

Before:

After:

ConstexprMethodCase

When defined, the check will ensure constexpr method names conform to the selected casing.

ConstexprMethodPrefix

When defined, the check will ensure constexpr method names will add the prefixed with the given value (regardless of casing).

ConstexprMethodSuffix

When defined, the check will ensure constexpr method names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ConstexprMethodCase of lower_case
  • ConstexprMethodPrefix of pre_
  • ConstexprMethodSuffix of _post

Identifies and/or transforms constexpr method names as follows:

Before:

After:

ConstexprVariableCase

When defined, the check will ensure constexpr variable names conform to the selected casing.

ConstexprVariablePrefix

When defined, the check will ensure constexpr variable names will add the prefixed with the given value (regardless of casing).

ConstexprVariableSuffix

When defined, the check will ensure constexpr variable names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ConstexprVariableCase of lower_case
  • ConstexprVariablePrefix of pre_
  • ConstexprVariableSuffix of _post

Identifies and/or transforms constexpr variable names as follows:

Before:

After:

EnumCase

When defined, the check will ensure enumeration names conform to the selected casing.

EnumPrefix

When defined, the check will ensure enumeration names will add the prefixed with the given value (regardless of casing).

EnumSuffix

When defined, the check will ensure enumeration names will add the suffix with the given value (regardless of casing).

For example using values of:

  • EnumCase of lower_case
  • EnumPrefix of pre_
  • EnumSuffix of _post

Identifies and/or transforms enumeration names as follows:

Before:

After:

EnumConstantCase

When defined, the check will ensure enumeration constant names conform to the selected casing.

EnumConstantPrefix

When defined, the check will ensure enumeration constant names will add the prefixed with the given value (regardless of casing).

EnumConstantSuffix

When defined, the check will ensure enumeration constant names will add the suffix with the given value (regardless of casing).

For example using values of:

  • EnumConstantCase of lower_case
  • EnumConstantPrefix of pre_
  • EnumConstantSuffix of _post

Identifies and/or transforms enumeration constant names as follows:

Before:

After:

FunctionCase

When defined, the check will ensure function names conform to the selected casing.

FunctionPrefix

When defined, the check will ensure function names will add the prefixed with the given value (regardless of casing).

FunctionSuffix

When defined, the check will ensure function names will add the suffix with the given value (regardless of casing).

For example using values of:

  • FunctionCase of lower_case
  • FunctionPrefix of pre_
  • FunctionSuffix of _post

Identifies and/or transforms function names as follows:

Before:

After:

GlobalConstantCase

When defined, the check will ensure global constant names conform to the selected casing.

GlobalConstantPrefix

When defined, the check will ensure global constant names will add the prefixed with the given value (regardless of casing).

GlobalConstantSuffix

When defined, the check will ensure global constant names will add the suffix with the given value (regardless of casing).

For example using values of:

  • GlobalConstantCase of lower_case
  • GlobalConstantPrefix of pre_
  • GlobalConstantSuffix of _post

Identifies and/or transforms global constant names as follows:

Before:

After:

GlobalConstantPointerCase

When defined, the check will ensure global constant pointer names conform to the selected casing.

GlobalConstantPointerPrefix

When defined, the check will ensure global constant pointer names will add the prefixed with the given value (regardless of casing).

GlobalConstantPointerSuffix

When defined, the check will ensure global constant pointer names will add the suffix with the given value (regardless of casing).

For example using values of:

  • GlobalConstantPointerCase of lower_case
  • GlobalConstantPointerPrefix of pre_
  • GlobalConstantPointerSuffix of _post

Identifies and/or transforms global constant pointer names as follows:

Before:

After:

GlobalFunctionCase

When defined, the check will ensure global function names conform to the selected casing.

GlobalFunctionPrefix

When defined, the check will ensure global function names will add the prefixed with the given value (regardless of casing).

GlobalFunctionSuffix

When defined, the check will ensure global function names will add the suffix with the given value (regardless of casing).

For example using values of:

  • GlobalFunctionCase of lower_case
  • GlobalFunctionPrefix of pre_
  • GlobalFunctionSuffix of _post

Identifies and/or transforms global function names as follows:

Before:

After:

GlobalPointerCase

When defined, the check will ensure global pointer names conform to the selected casing.

GlobalPointerPrefix

When defined, the check will ensure global pointer names will add the prefixed with the given value (regardless of casing).

GlobalPointerSuffix

When defined, the check will ensure global pointer names will add the suffix with the given value (regardless of casing).

For example using values of:

  • GlobalPointerCase of lower_case
  • GlobalPointerPrefix of pre_
  • GlobalPointerSuffix of _post

Identifies and/or transforms global pointer names as follows:

Before:

After:

GlobalVariableCase

When defined, the check will ensure global variable names conform to the selected casing.

GlobalVariablePrefix

When defined, the check will ensure global variable names will add the prefixed with the given value (regardless of casing).

GlobalVariableSuffix

When defined, the check will ensure global variable names will add the suffix with the given value (regardless of casing).

For example using values of:

  • GlobalVariableCase of lower_case
  • GlobalVariablePrefix of pre_
  • GlobalVariableSuffix of _post

Identifies and/or transforms global variable names as follows:

Before:

After:

IgnoreMainLikeFunctions

When set to 1 functions that have a similar signature to main or wmain won't enforce checks on the names of their parameters. Default value is 0.

InlineNamespaceCase

When defined, the check will ensure inline namespaces names conform to the selected casing.

InlineNamespacePrefix

When defined, the check will ensure inline namespaces names will add the prefixed with the given value (regardless of casing).

InlineNamespaceSuffix

When defined, the check will ensure inline namespaces names will add the suffix with the given value (regardless of casing).

For example using values of:

  • InlineNamespaceCase of lower_case
  • InlineNamespacePrefix of pre_
  • InlineNamespaceSuffix of _post

Identifies and/or transforms inline namespaces names as follows:

Before:

After:

LocalConstantCase

When defined, the check will ensure local constant names conform to the selected casing.

LocalConstantPrefix

When defined, the check will ensure local constant names will add the prefixed with the given value (regardless of casing).

LocalConstantSuffix

When defined, the check will ensure local constant names will add the suffix with the given value (regardless of casing).

For example using values of:

  • LocalConstantCase of lower_case
  • LocalConstantPrefix of pre_
  • LocalConstantSuffix of _post

Identifies and/or transforms local constant names as follows:

Before:

After:

LocalConstantPointerCase

When defined, the check will ensure local constant pointer names conform to the selected casing.

LocalConstantPointerPrefix

When defined, the check will ensure local constant pointer names will add the prefixed with the given value (regardless of casing).

LocalConstantPointerSuffix

When defined, the check will ensure local constant pointer names will add the suffix with the given value (regardless of casing).

For example using values of:

  • LocalConstantPointerCase of lower_case
  • LocalConstantPointerPrefix of pre_
  • LocalConstantPointerSuffix of _post

Identifies and/or transforms local constant pointer names as follows:

Before:

After:

LocalPointerCase

When defined, the check will ensure local pointer names conform to the selected casing.

LocalPointerPrefix

When defined, the check will ensure local pointer names will add the prefixed with the given value (regardless of casing).

LocalPointerSuffix

When defined, the check will ensure local pointer names will add the suffix with the given value (regardless of casing).

For example using values of:

  • LocalPointerCase of lower_case
  • LocalPointerPrefix of pre_
  • LocalPointerSuffix of _post

Identifies and/or transforms local pointer names as follows:

Before:

After:

LocalVariableCase

When defined, the check will ensure local variable names conform to the selected casing.

LocalVariablePrefix

When defined, the check will ensure local variable names will add the prefixed with the given value (regardless of casing).

LocalVariableSuffix

When defined, the check will ensure local variable names will add the suffix with the given value (regardless of casing).

For example using values of:

  • LocalVariableCase of lower_case
  • LocalVariablePrefix of pre_
  • LocalVariableSuffix of _post

Identifies and/or transforms local variable names as follows:

Before:

After:

MemberCase

When defined, the check will ensure member names conform to the selected casing.

MemberPrefix

When defined, the check will ensure member names will add the prefixed with the given value (regardless of casing).

MemberSuffix

When defined, the check will ensure member names will add the suffix with the given value (regardless of casing).

For example using values of:

  • MemberCase of lower_case
  • MemberPrefix of pre_
  • MemberSuffix of _post

Identifies and/or transforms member names as follows:

Before:

After:

MethodCase

When defined, the check will ensure method names conform to the selected casing.

MethodPrefix

When defined, the check will ensure method names will add the prefixed with the given value (regardless of casing).

MethodSuffix

When defined, the check will ensure method names will add the suffix with the given value (regardless of casing).

For example using values of:

  • MethodCase of lower_case
  • MethodPrefix of pre_
  • MethodSuffix of _post

Identifies and/or transforms method names as follows:

Before:

After:

NamespaceCase

When defined, the check will ensure namespace names conform to the selected casing.

NamespacePrefix

When defined, the check will ensure namespace names will add the prefixed with the given value (regardless of casing).

NamespaceSuffix

When defined, the check will ensure namespace names will add the suffix with the given value (regardless of casing).

For example using values of:

  • NamespaceCase of lower_case
  • NamespacePrefix of pre_
  • NamespaceSuffix of _post

Identifies and/or transforms namespace names as follows:

Before:

After:

ParameterCase

When defined, the check will ensure parameter names conform to the selected casing.

ParameterPrefix

When defined, the check will ensure parameter names will add the prefixed with the given value (regardless of casing).

ParameterSuffix

When defined, the check will ensure parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ParameterCase of lower_case
  • ParameterPrefix of pre_
  • ParameterSuffix of _post

Identifies and/or transforms parameter names as follows:

Before:

After:

ParameterPackCase

When defined, the check will ensure parameter pack names conform to the selected casing.

ParameterPackPrefix

When defined, the check will ensure parameter pack names will add the prefixed with the given value (regardless of casing).

ParameterPackSuffix

When defined, the check will ensure parameter pack names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ParameterPackCase of lower_case
  • ParameterPackPrefix of pre_
  • ParameterPackSuffix of _post

Identifies and/or transforms parameter pack names as follows:

Before:

After:

PointerParameterCase

When defined, the check will ensure pointer parameter names conform to the selected casing.

PointerParameterPrefix

When defined, the check will ensure pointer parameter names will add the prefixed with the given value (regardless of casing).

PointerParameterSuffix

When defined, the check will ensure pointer parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • PointerParameterCase of lower_case
  • PointerParameterPrefix of pre_
  • PointerParameterSuffix of _post

Identifies and/or transforms pointer parameter names as follows:

Before:

After:

PrivateMemberCase

When defined, the check will ensure private member names conform to the selected casing.

PrivateMemberPrefix

When defined, the check will ensure private member names will add the prefixed with the given value (regardless of casing).

PrivateMemberSuffix

When defined, the check will ensure private member names will add the suffix with the given value (regardless of casing).

For example using values of:

  • PrivateMemberCase of lower_case
  • PrivateMemberPrefix of pre_
  • PrivateMemberSuffix of _post

Identifies and/or transforms private member names as follows:

Before:

After:

PrivateMethodCase

When defined, the check will ensure private method names conform to the selected casing.

PrivateMethodPrefix

When defined, the check will ensure private method names will add the prefixed with the given value (regardless of casing).

PrivateMethodSuffix

When defined, the check will ensure private method names will add the suffix with the given value (regardless of casing).

For example using values of:

  • PrivateMethodCase of lower_case
  • PrivateMethodPrefix of pre_
  • PrivateMethodSuffix of _post

Identifies and/or transforms private method names as follows:

Before:

After:

ProtectedMemberCase

When defined, the check will ensure protected member names conform to the selected casing.

ProtectedMemberPrefix

When defined, the check will ensure protected member names will add the prefixed with the given value (regardless of casing).

ProtectedMemberSuffix

When defined, the check will ensure protected member names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ProtectedMemberCase of lower_case
  • ProtectedMemberPrefix of pre_
  • ProtectedMemberSuffix of _post

Identifies and/or transforms protected member names as follows:

Before:

After:

ProtectedMethodCase

When defined, the check will ensure protect method names conform to the selected casing.

ProtectedMethodPrefix

When defined, the check will ensure protect method names will add the prefixed with the given value (regardless of casing).

ProtectedMethodSuffix

When defined, the check will ensure protect method names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ProtectedMethodCase of lower_case
  • ProtectedMethodPrefix of pre_
  • ProtectedMethodSuffix of _post

Identifies and/or transforms protect method names as follows:

Before:

After:

PublicMemberCase

When defined, the check will ensure public member names conform to the selected casing.

PublicMemberPrefix

When defined, the check will ensure public member names will add the prefixed with the given value (regardless of casing).

PublicMemberSuffix

When defined, the check will ensure public member names will add the suffix with the given value (regardless of casing).

For example using values of:

  • PublicMemberCase of lower_case
  • PublicMemberPrefix of pre_
  • PublicMemberSuffix of _post

Identifies and/or transforms public member names as follows:

Before:

After:

PublicMethodCase

When defined, the check will ensure public method names conform to the selected casing.

PublicMethodPrefix

When defined, the check will ensure public method names will add the prefixed with the given value (regardless of casing).

PublicMethodSuffix

When defined, the check will ensure public method names will add the suffix with the given value (regardless of casing).

For example using values of:

  • PublicMethodCase of lower_case
  • PublicMethodPrefix of pre_
  • PublicMethodSuffix of _post

Identifies and/or transforms public method names as follows:

Before:

After:

StaticConstantCase

When defined, the check will ensure static constant names conform to the selected casing.

StaticConstantPrefix

When defined, the check will ensure static constant names will add the prefixed with the given value (regardless of casing).

StaticConstantSuffix

When defined, the check will ensure static constant names will add the suffix with the given value (regardless of casing).

For example using values of:

  • StaticConstantCase of lower_case
  • StaticConstantPrefix of pre_
  • StaticConstantSuffix of _post

Identifies and/or transforms static constant names as follows:

Before:

After:

StaticVariableCase

When defined, the check will ensure static variable names conform to the selected casing.

StaticVariablePrefix

When defined, the check will ensure static variable names will add the prefixed with the given value (regardless of casing).

StaticVariableSuffix

When defined, the check will ensure static variable names will add the suffix with the given value (regardless of casing).

For example using values of:

  • StaticVariableCase of lower_case
  • StaticVariablePrefix of pre_
  • StaticVariableSuffix of _post

Identifies and/or transforms static variable names as follows:

Before:

After:

StructCase

When defined, the check will ensure struct names conform to the selected casing.

StructPrefix

When defined, the check will ensure struct names will add the prefixed with the given value (regardless of casing).

StructSuffix

When defined, the check will ensure struct names will add the suffix with the given value (regardless of casing).

For example using values of:

  • StructCase of lower_case
  • StructPrefix of pre_
  • StructSuffix of _post

Identifies and/or transforms struct names as follows:

Before:

After:

TemplateParameterCase

When defined, the check will ensure template parameter names conform to the selected casing.

TemplateParameterPrefix

When defined, the check will ensure template parameter names will add the prefixed with the given value (regardless of casing).

TemplateParameterSuffix

When defined, the check will ensure template parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • TemplateParameterCase of lower_case
  • TemplateParameterPrefix of pre_
  • TemplateParameterSuffix of _post

Identifies and/or transforms template parameter names as follows:

Before:

After:

TemplateTemplateParameterCase

When defined, the check will ensure template template parameter names conform to the selected casing.

TemplateTemplateParameterPrefix

When defined, the check will ensure template template parameter names will add the prefixed with the given value (regardless of casing).

TemplateTemplateParameterSuffix

When defined, the check will ensure template template parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • TemplateTemplateParameterCase of lower_case
  • TemplateTemplateParameterPrefix of pre_
  • TemplateTemplateParameterSuffix of _post

Identifies and/or transforms template template parameter names as follows:

Before:

After:

TypeAliasCase

When defined, the check will ensure type alias names conform to the selected casing.

TypeAliasPrefix

When defined, the check will ensure type alias names will add the prefixed with the given value (regardless of casing).

TypeAliasSuffix

When defined, the check will ensure type alias names will add the suffix with the given value (regardless of casing).

For example using values of:

  • TypeAliasCase of lower_case
  • TypeAliasPrefix of pre_
  • TypeAliasSuffix of _post

Identifies and/or transforms type alias names as follows:

Before:

After:

TypedefCase

When defined, the check will ensure typedef names conform to the selected casing.

TypedefPrefix

When defined, the check will ensure typedef names will add the prefixed with the given value (regardless of casing).

TypedefSuffix

When defined, the check will ensure typedef names will add the suffix with the given value (regardless of casing).

For example using values of:

  • TypedefCase of lower_case
  • TypedefPrefix of pre_
  • TypedefSuffix of _post

Identifies and/or transforms typedef names as follows:

Before:

After:

TypeTemplateParameterCase

When defined, the check will ensure type template parameter names conform to the selected casing.

TypeTemplateParameterPrefix

When defined, the check will ensure type template parameter names will add the prefixed with the given value (regardless of casing).

TypeTemplateParameterSuffix

When defined, the check will ensure type template parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • TypeTemplateParameterCase of lower_case
  • TypeTemplateParameterPrefix of pre_
  • TypeTemplateParameterSuffix of _post

Identifies and/or transforms type template parameter names as follows:

Before:

After:

UnionCase

When defined, the check will ensure union names conform to the selected casing.

UnionPrefix

When defined, the check will ensure union names will add the prefixed with the given value (regardless of casing).

UnionSuffix

When defined, the check will ensure union names will add the suffix with the given value (regardless of casing).

For example using values of:

  • UnionCase of lower_case
  • UnionPrefix of pre_
  • UnionSuffix of _post

Identifies and/or transforms union names as follows:

Before:

After:

ValueTemplateParameterCase

When defined, the check will ensure value template parameter names conform to the selected casing.

ValueTemplateParameterPrefix

When defined, the check will ensure value template parameter names will add the prefixed with the given value (regardless of casing).

ValueTemplateParameterSuffix

When defined, the check will ensure value template parameter names will add the suffix with the given value (regardless of casing).

For example using values of:

  • ValueTemplateParameterCase of lower_case
  • ValueTemplateParameterPrefix of pre_
  • ValueTemplateParameterSuffix of _post

Identifies and/or transforms value template parameter names as follows:

Before:

After:

VariableCase

When defined, the check will ensure variable names conform to the selected casing.

VariablePrefix

When defined, the check will ensure variable names will add the prefixed with the given value (regardless of casing).

VariableSuffix

When defined, the check will ensure variable names will add the suffix with the given value (regardless of casing).

For example using values of:

  • VariableCase of lower_case
  • VariablePrefix of pre_
  • VariableSuffix of _post

Identifies and/or transforms variable names as follows:

Before:

After:

VirtualMethodCase

When defined, the check will ensure virtual method names conform to the selected casing.

VirtualMethodPrefix

When defined, the check will ensure virtual method names will add the prefixed with the given value (regardless of casing).

VirtualMethodSuffix

When defined, the check will ensure virtual method names will add the suffix with the given value (regardless of casing).

For example using values of:

  • VirtualMethodCase of lower_case
  • VirtualMethodPrefix of pre_
  • VirtualMethodSuffix of _post

Identifies and/or transforms virtual method names as follows:

Before:

After: