This commit is contained in:
Andrei Astafev 2020-04-11 21:53:54 +03:00
parent 5fa1f983b8
commit c99b5f0559
2 changed files with 188 additions and 186 deletions

View File

@ -6,3 +6,5 @@ page:
image:
caption:
align: inherit
caption:
font-style: normal

View File

@ -53,10 +53,10 @@ https://git.246060.ru/f1x1t/clang-tidy-readability-identifier-naming[Проек
[cols=",",options="header",]
|===
|Параметр |Значение
|AbstractClassCase |`CamelCase`
|AbstractClassPrefix |`''`
|AbstractClassSuffix |`''`
| Параметр | Значение
| AbstractClassCase | `CamelCase`
| AbstractClassPrefix | `''`
| AbstractClassSuffix | `''`
|===
Пример кода до форматирования:
@ -83,10 +83,10 @@ class AbstractClass {
[cols=",",options="header",]
|===
|Параметр |Значение
|ClassCase |`CamelCase`
|ClassPrefix |`''`
|ClassSuffix |`''`
| Параметр | Значение
| ClassCase | `CamelCase`
| ClassPrefix | `''`
| ClassSuffix | `''`
|===
Пример кода до форматирования:
@ -115,10 +115,10 @@ class TestClass {
[cols=",",options="header",]
|===
|Параметр |Значение
|StructCase |`CamelCase`
|StructPrefix |`''`
|StructSuffix |`''`
| Параметр | Значение
| StructCase | `CamelCase`
| StructPrefix | `''`
| StructSuffix | `''`
|===
Пример кода до форматирования:
@ -143,10 +143,10 @@ struct TestStruct {
[cols=",",options="header",]
|===
|Параметр |Значение
|UnionCase |`CamelCase`
|UnionPrefix |`''`
|UnionSuffix |`''`
| Параметр | Значение
| UnionCase | `CamelCase`
| UnionPrefix | `''`
| UnionSuffix | `''`
|===
Пример кода до форматирования:
@ -173,10 +173,10 @@ union TestUnion {
[cols=",",options="header",]
|===
|Параметр |Значение
|EnumCase |`CamelCase`
|EnumPrefix |`''`
|EnumSuffix |`''`
| Параметр | Значение
| EnumCase | `CamelCase`
| EnumPrefix | `''`
| EnumSuffix | `''`
|===
Пример кода до форматирования:
@ -197,10 +197,10 @@ enum TestEnum { ONE, TWO };
[cols=",",options="header",]
|===
|Параметр |Значение
|EnumConstantCase |`UPPER_CASE`
|EnumConstantPrefix |`''`
|EnumConstantSuffix |`''`
| Параметр | Значение
| EnumConstantCase | `UPPER_CASE`
| EnumConstantPrefix | `''`
| EnumConstantSuffix | `''`
|===
Пример кода до форматирования:
@ -221,10 +221,10 @@ enum TestEnum { ONE, TWO };
[cols=",",options="header",]
|===
|Параметр |Значение
|NamespaceCase |`lower_case`
|NamespacePrefix |`''`
|NamespaceSuffix |`''`
| Параметр | Значение
| NamespaceCase | `lower_case`
| NamespacePrefix | `''`
| NamespaceSuffix | `''`
|===
Пример кода до форматирования:
@ -249,10 +249,10 @@ namespace test_ns {
[cols=",",options="header",]
|===
|Параметр |Значение
|InlineNamespaceCase |`lower_case`
|InlineNamespacePrefix |`''`
|InlineNamespaceSuffix |`''`
| Параметр | Значение
| InlineNamespaceCase | `lower_case`
| InlineNamespacePrefix | `''`
| InlineNamespaceSuffix | `''`
|===
Пример кода до форматирования:
@ -281,10 +281,10 @@ inline namespace inline_namespace {
[cols=",",options="header",]
|===
|Параметр |Значение
|TypeAliasCase |`lower_case`
|TypeAliasPrefix |`''`
|TypeAliasSuffix |`''`
| Параметр | Значение
| TypeAliasCase | `lower_case`
| TypeAliasPrefix | `''`
| TypeAliasSuffix | `''`
|===
Пример кода до форматирования:
@ -311,10 +311,10 @@ using MyStructType = MyStructure;
[cols=",",options="header",]
|===
|Параметр |Значение
|TypedefCase |`lower_case`
|TypedefPrefix |`''`
|TypedefSuffix |`''`
| Параметр | Значение
| TypedefCase | `lower_case`
| TypedefPrefix | `''`
| TypedefSuffix | `''`
|===
Пример кода до форматирования:
@ -339,10 +339,10 @@ typedef int my_int;
[cols=",",options="header",]
|===
|Параметр |Значение
|GlobalVariableCase |`lower_case`
|GlobalVariablePrefix |`''`
|GlobalVariableSuffix |`''`
| Параметр | Значение
| GlobalVariableCase | `lower_case`
| GlobalVariablePrefix | `''`
| GlobalVariableSuffix | `''`
|===
Пример кода до форматирования:
@ -363,10 +363,10 @@ unsigned global_variable;
[cols=",",options="header",]
|===
|Параметр |Значение
|LocalVariableCase |`camelBack`
|LocalVariablePrefix |`''`
|LocalVariableSuffix |`''`
| Параметр | Значение
| LocalVariableCase | `camelBack`
| LocalVariablePrefix | `''`
| LocalVariableSuffix | `''`
|===
Пример кода до форматирования:
@ -393,10 +393,10 @@ int function() {
[cols=",",options="header",]
|===
|Параметр |Значение
|StaticVariableCase |`camelBack`
|StaticVariablePrefix |`''`
|StatucVariableSuffix |`''`
| Параметр | Значение
| StaticVariableCase | `camelBack`
| StaticVariablePrefix | `''`
| StatucVariableSuffix | `''`
|===
Пример кода до форматирования:
@ -423,10 +423,10 @@ int functionWithStaticVariable() {
[cols=",",options="header",]
|===
|Параметр |Значение
|ConstexprVariableCase |`lower_case`
|ConstexprVariablePrefix |`''`
|ConstexprVariableSuffix |`''`
| Параметр | Значение
| ConstexprVariableCase | `lower_case`
| ConstexprVariablePrefix | `''`
| ConstexprVariableSuffix | `''`
|===
Пример кода до форматирования:
@ -447,10 +447,10 @@ constexpr int const_five = 5;
[cols=",",options="header",]
|===
|Параметр |Значение
|GlobalPointerCase |`lower_case`
|GlobalPointerPrefix |`''`
|GlobalPointerSuffix |`''`
| Параметр | Значение
| GlobalPointerCase | `lower_case`
| GlobalPointerPrefix | `''`
| GlobalPointerSuffix | `''`
|===
Пример кода до форматирования:
@ -471,10 +471,10 @@ void* global_pointer;
[cols=",",options="header",]
|===
|Параметр |Значение
|LocalPointerCase |`camelBack`
|LocalPointerPrefix |`''`
|LocalPointerSuffix |`''`
| Параметр | Значение
| LocalPointerCase | `camelBack`
| LocalPointerPrefix | `''`
| LocalPointerSuffix | `''`
|===
Пример кода до форматирования:
@ -503,10 +503,10 @@ void* function() {
[cols=",",options="header",]
|===
|Параметр |Значение
|ClassMemberCase |`camelBack`
|ClassMemberPrefix |`''`
|ClassMemberSuffix |`''`
| Параметр | Значение
| ClassMemberCase | `camelBack`
| ClassMemberPrefix | `''`
| ClassMemberSuffix | `''`
|===
Пример кода до форматирования:
@ -533,10 +533,10 @@ class ClassWithClassMember {
[cols=",",options="header",]
|===
|Параметр |Значение
|ConstantMemberCase |`lower_case`
|ConstantMemberPrefix |`''`
|ConstantMemberSuffix |`''`
| Параметр | Значение
| ConstantMemberCase | `lower_case`
| ConstantMemberPrefix | `''`
| ConstantMemberSuffix | `''`
|===
Пример кода до форматирования:
@ -561,10 +561,10 @@ class ClassWithConstantMember {
[cols=",",options="header",]
|===
|Параметр |Значение
|PrivateMemberCase |`camelBack`
|PrivateMemberPrefix |`'m_'`
|PrivateMemberSuffix |`''`
| Параметр | Значение
| PrivateMemberCase | `camelBack`
| PrivateMemberPrefix | `'m_'`
| PrivateMemberSuffix | `''`
|===
Пример кода до форматирования:
@ -591,10 +591,10 @@ class ClassWithPrivateMember {
[cols=",",options="header",]
|===
|Параметр |Значение
|ProtectedMemberCase |`camelBack`
|ProtectedMemberPrefix |`''`
|ProtectedMemberSuffix |`''`
| Параметр | Значение
| ProtectedMemberCase | `camelBack`
| ProtectedMemberPrefix | `''`
| ProtectedMemberSuffix | `''`
|===
Пример кода до форматирования:
@ -621,10 +621,10 @@ class ClassWithProtectedMember {
[cols=",",options="header",]
|===
|Параметр |Значение
|PublicMemberCase |`camelBack`
|PublicMemberPrefix |`''`
|PublicMemberSuffix |`''`
| Параметр | Значение
| PublicMemberCase | `camelBack`
| PublicMemberPrefix | `''`
| PublicMemberSuffix | `''`
|===
Пример кода до форматирования:
@ -653,10 +653,10 @@ class ClassWithPublicMember {
[cols=",",options="header",]
|===
|Параметр |Значение
|ConstantCase |`UPPER_CASE`
|ConstantPrefix |`''`
|ConstantSuffix |`''`
| Параметр | Значение
| ConstantCase | `UPPER_CASE`
| ConstantPrefix | `''`
| ConstantSuffix | `''`
|===
Пример кода до форматирования:
@ -677,10 +677,10 @@ const int THE_ONE = 1;
[cols=",",options="header",]
|===
|Параметр |Значение
|GlobalConstantCase |`UPPER_CASE`
|GlobalConstantPrefix |`''`
|GlobalConstantSuffix |`''`
| Параметр | Значение
| GlobalConstantCase | `UPPER_CASE`
| GlobalConstantPrefix | `''`
| GlobalConstantSuffix | `''`
|===
Пример кода до форматирования:
@ -701,10 +701,10 @@ const int THE_ONE = 1;
[cols=",",options="header",]
|===
|Параметр |Значение
|LocalConstantCase |`camelBack`
|LocalConstantPrefix |`''`
|LocalConstantSuffix |`''`
| Параметр | Значение
| LocalConstantCase | `camelBack`
| LocalConstantPrefix | `''`
| LocalConstantSuffix | `''`
|===
Пример кода до форматирования:
@ -731,10 +731,10 @@ int functionWithLocalConstant() {
[cols=",",options="header",]
|===
|Параметр |Значение
|StaticConstantCase |`camelBack`
|StaticConstantPrefix |`''`
|StaticConstantSuffix |`''`
| Параметр | Значение
| StaticConstantCase | `camelBack`
| StaticConstantPrefix | `''`
| StaticConstantSuffix | `''`
|===
Пример кода до форматирования:
@ -761,10 +761,10 @@ int functionWithStaticConstant() {
[cols=",",options="header",]
|===
|Параметр |Значение
|ClassConstantCase |`UPPER_CASE`
|ClassConstantPrefix |`''`
|ClassConstantSuffix |`''`
| Параметр | Значение
| ClassConstantCase | `UPPER_CASE`
| ClassConstantPrefix | `''`
| ClassConstantSuffix | `''`
|===
Пример кода до форматирования:
@ -791,10 +791,10 @@ class ClassWithClassConstant {
[cols=",",options="header",]
|===
|Параметр |Значение
|GlobalConstantPointerCase |`lower_case`
|GlobalConstantPointerPrefix |`''`
|GlobalConstantPointerSuffix |`''`
| Параметр | Значение
| GlobalConstantPointerCase | `lower_case`
| GlobalConstantPointerPrefix | `''`
| GlobalConstantPointerSuffix | `''`
|===
Пример кода до форматирования:
@ -817,10 +817,10 @@ void* const global_const_pointer = global_pointer;
[cols=",",options="header",]
|===
|Параметр |Значение
|LocalConstantPointerCase |`camelBack`
|LocalConstantPointerPrefix |`''`
|LocalConstantPointerSuffix |`''`
| Параметр | Значение
| LocalConstantPointerCase | `camelBack`
| LocalConstantPointerPrefix | `''`
| LocalConstantPointerSuffix | `''`
|===
Пример кода до форматирования:
@ -851,10 +851,10 @@ void* functionWithLocalConstPointer() {
[cols=",",options="header",]
|===
|Параметр |Значение
|FunctionCase |`camelBack`
|FunctionPrefix |`''`
|FunctionSuffix |`''`
| Параметр | Значение
| FunctionCase | `camelBack`
| FunctionPrefix | `''`
| FunctionSuffix | `''`
|===
Пример кода до форматирования:
@ -879,10 +879,10 @@ static int staticFunction() {
[cols=",",options="header",]
|===
|Параметр |Значение
|GlobalFunctionCase |`camelBack`
|GlobalFunctionPrefix |`''`
|GlobalFunctionSuffix |`''`
| Параметр | Значение
| GlobalFunctionCase | `camelBack`
| GlobalFunctionPrefix | `''`
| GlobalFunctionSuffix | `''`
|===
Пример кода до форматирования:
@ -907,10 +907,10 @@ int globalFunction() {
[cols=",",options="header",]
|===
|Параметр |Значение
|ConstexprFunctionCase |`camelBack`
|ConstexprFunctionPrefix |`''`
|ConstexprFunctionSuffix |`''`
| Параметр | Значение
| ConstexprFunctionCase | `camelBack`
| ConstexprFunctionPrefix | `''`
| ConstexprFunctionSuffix | `''`
|===
Пример кода до форматирования:
@ -937,10 +937,10 @@ constexpr int getFive() {
[cols=",",options="header",]
|===
|Параметр |Значение
|ClassMethodCase |`camelBack`
|ClassMethodPrefix |`''`
|ClassMethodSuffix |`''`
| Параметр | Значение
| ClassMethodCase | `camelBack`
| ClassMethodPrefix | `''`
| ClassMethodSuffix | `''`
|===
Пример кода до форматирования:
@ -967,10 +967,10 @@ class ClassWithMethod {
[cols=",",options="header",]
|===
|Параметр |Значение
|ConstexprMethodCase |`camelBack`
|ConstexprMethodPrefix |`''`
|ConstexprMethodSuffix |`''`
| Параметр | Значение
| ConstexprMethodCase | `camelBack`
| ConstexprMethodPrefix | `''`
| ConstexprMethodSuffix | `''`
|===
Пример кода до форматирования:
@ -997,10 +997,10 @@ class ClassWithConstexprMethod {
[cols=",",options="header",]
|===
|Параметр |Значение
|VirtualMethodCase |`camelBack`
|VirtualMethodPrefix |`''`
|VirtualMethodSuffix |`''`
| Параметр | Значение
| VirtualMethodCase | `camelBack`
| VirtualMethodPrefix | `''`
| VirtualMethodSuffix | `''`
|===
Пример кода до форматирования:
@ -1027,10 +1027,10 @@ class ClassWithVirtualMethod {
[cols=",",options="header",]
|===
|Параметр |Значение
|PrivateMethodCase |`camelBack`
|PrivateMethodPrefix |`''`
|PrivateMethodSuffix |`''`
| Параметр | Значение
| PrivateMethodCase | `camelBack`
| PrivateMethodPrefix | `''`
| PrivateMethodSuffix | `''`
|===
Пример кода до форматирования:
@ -1040,7 +1040,7 @@ class ClassWithVirtualMethod {
class ClassWithPrivateMethod {
private:
int get_int() { return 0; };
};
};
----
Пример кода после форматирования:
@ -1050,17 +1050,17 @@ class ClassWithPrivateMethod {
class ClassWithPrivateMethod {
private:
int getInt() { return 0; };
};
};
----
=== ProtectedMethod (Защищённый метод)
[cols=",",options="header",]
|===
|Параметр |Значение
|ProtectedMethodCase |`camelBack`
|ProtectedMethodPrefix |`''`
|ProtectedMethodSuffix |`''`
| Параметр | Значение
| ProtectedMethodCase | `camelBack`
| ProtectedMethodPrefix | `''`
| ProtectedMethodSuffix | `''`
|===
Пример кода до форматирования:
@ -1087,10 +1087,10 @@ class ClassWithProtectedMethod {
[cols=",",options="header",]
|===
|Параметр |Значение
|PublicMethodCase |`camelBack`
|PublicMethodPrefix |`''`
|PublicMethodSuffix |`''`
| Параметр | Значение
| PublicMethodCase | `camelBack`
| PublicMethodPrefix | `''`
| PublicMethodSuffix | `''`
|===
Пример кода до форматирования:
@ -1119,10 +1119,10 @@ class ClassWithPublicMethod {
[cols=",",options="header",]
|===
|Параметр |Значение
|ParameterCase |`camelBack`
|ParameterPrefix |`''`
|ParameterSuffix |`''`
| Параметр | Значение
| ParameterCase | `camelBack`
| ParameterPrefix | `''`
| ParameterSuffix | `''`
|===
Пример кода до форматирования:
@ -1147,10 +1147,10 @@ int returnInt(int returnValue) {
[cols=",",options="header",]
|===
|Параметр |Значение
|ConstantParameterCase |`camelBack`
|ConstantParameterPrefix |`''`
|ConstantParameterSuffix |`''`
| Параметр | Значение
| ConstantParameterCase | `camelBack`
| ConstantParameterPrefix | `''`
| ConstantParameterSuffix | `''`
|===
Пример кода до форматирования:
@ -1175,10 +1175,10 @@ char returnChar(const char returnValue) {
[cols=",",options="header",]
|===
|Параметр |Значение
|ConstantPointerParameterCase |`camelBack`
|ConstantPointerParameterPrefix |`''`
|ConstantPointerParameterSuffix |`''`
| Параметр | Значение
| ConstantPointerParameterCase | `camelBack`
| ConstantPointerParameterPrefix | `''`
| ConstantPointerParameterSuffix | `''`
|===
Пример кода до форматирования:
@ -1203,10 +1203,10 @@ void* returnVoid(void* const returnValue) {
[cols=",",options="header",]
|===
|Параметр |Значение
|PointerParameterCase |`camelBack`
|PointerParameterPrefix |`''`
|PointerParameterSuffix |`''`
| Параметр | Значение
| PointerParameterCase | `camelBack`
| PointerParameterPrefix | `''`
| PointerParameterSuffix | `''`
|===
Пример кода до форматирования:
@ -1233,10 +1233,10 @@ void* returnPtr(void* returnValue) {
[cols=",",options="header",]
|===
|Параметр |Значение
|TemplateParameterCase |`camelBack`
|TemplateParameterPrefix |`''`
|TemplateParameterSuffix |`''`
| Параметр | Значение
| TemplateParameterCase | `camelBack`
| TemplateParameterPrefix | `''`
| TemplateParameterSuffix | `''`
|===
Пример кода до форматирования:
@ -1261,10 +1261,10 @@ template<typename TType> int tFunction(TType tValue) {
[cols=",",options="header",]
|===
|Параметр |Значение
|ParameterPackCase |`camelBack`
|ParameterPackPrefix |`''`
|ParameterPackSuffix |`''`
| Параметр | Значение
| ParameterPackCase | `camelBack`
| ParameterPackPrefix | `''`
| ParameterPackSuffix | `''`
|===
Пример кода до форматирования:
@ -1285,10 +1285,10 @@ template<class ... Types> void f(Types ... parametersPack);
[cols=",",options="header",]
|===
|Параметр |Значение
|TemplateTemplateParameterCase |`camelBack`
|TemplateTemplateParameterPrefix |`''`
|TemplateTemplateParameterSuffix |`''`
| Параметр | Значение
| TemplateTemplateParameterCase | `camelBack`
| TemplateTemplateParameterPrefix | `''`
| TemplateTemplateParameterSuffix | `''`
|===
Пример кода до форматирования:
@ -1311,10 +1311,10 @@ class AllmightyClass { };
[cols=",",options="header",]
|===
|Параметр |Значение
|TypeTemplateParameterCase |`CamelCase`
|TypeTemplateParameterPrefix |`''`
|TypeTemplateParameterSuffix |`''`
| Параметр | Значение
| TypeTemplateParameterCase | `CamelCase`
| TypeTemplateParameterPrefix | `''`
| TypeTemplateParameterSuffix | `''`
|===
Пример кода до форматирования:
@ -1339,10 +1339,10 @@ template<typename TType>int tFunction(TType value) {
[cols=",",options="header",]
|===
|Параметр |Значение
|ValueTemplateParameterCase |`camelBack`
|ValueTemplateParameterPrefix |`''`
|ValueTemplateParameterSuffix |`''`
| Параметр | Значение
| ValueTemplateParameterCase | `camelBack`
| ValueTemplateParameterPrefix | `''`
| ValueTemplateParameterSuffix | `''`
|===
Пример кода до форматирования: