diff options
Diffstat (limited to 'docs/clang-tidy/checks/google-objc-global-variable-declaration.rst')
-rw-r--r-- | docs/clang-tidy/checks/google-objc-global-variable-declaration.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/clang-tidy/checks/google-objc-global-variable-declaration.rst b/docs/clang-tidy/checks/google-objc-global-variable-declaration.rst new file mode 100644 index 00000000..ae2b1ee3 --- /dev/null +++ b/docs/clang-tidy/checks/google-objc-global-variable-declaration.rst @@ -0,0 +1,42 @@ +.. title:: clang-tidy - google-objc-global-variable-declaration + +google-objc-global-variable-declaration +======================================= + +Finds global variable declarations in Objective-C files that are not follow the pattern +of variable names in Google's Objective-C Style Guide. + +The corresponding style guide rule: +http://google.github.io/styleguide/objcguide.html#variable-names + +All the global variables should follow the pattern of `g[A-Z].*` (variables) or +`k[A-Z].*` (constants). The check will suggest a variable name that follows the pattern +if it can be inferred from the original name. + +For code: + +.. code-block:: objc + static NSString* myString = @"hello"; + +The fix will be: + +.. code-block:: objc + static NSString* gMyString = @"hello"; + +Another example of constant: + +.. code-block:: objc + static NSString* const myConstString = @"hello"; + +The fix will be: + +.. code-block:: objc + static NSString* const kMyConstString = @"hello"; + +However for code that prefixed with non-alphabetical characters like: + +.. code-block:: objc + static NSString* __anotherString = @"world"; + +The check will give a warning message but will not be able to suggest a fix. The user +need to fix it on his own. |