|
2 | 2 |
|
3 | 3 | ## Coding style
|
4 | 4 |
|
5 |
| -Majority of OpenVINO components use `clang-format-9` for code style check. |
| 5 | +The majority of OpenVINO components use `clang-format-9` for code style check. |
6 | 6 |
|
7 |
| -The code style is based on Google Code style with some differences. All differences are described in the configuration file: |
| 7 | +The code style is based on the Google Code style with some differences. All the differences are described in the configuration file: |
8 | 8 | https://github.com/openvinotoolkit/openvino/blob/69f709028a5f8da596d1d0df9a0101e517c35708/src/.clang-format#L1-L28
|
9 | 9 |
|
10 |
| -To fix code style on your local machine, you need to have installed `clang-format-9` tool and be sure that CMake option `ENABLE_CLANG_FORMAT` is enabled. |
11 |
| -If all dependencies are resolved, `clang_format_fix_all` target can be used to fix all code style issues. |
| 10 | +To fix the code style on your local machine, you need to install the `clang-format-9` tool and make sure that the CMake option `ENABLE_CLANG_FORMAT` is enabled. |
| 11 | +If all dependencies are resolved, you can use the `clang_format_fix_all` target to fix all code style issues. |
12 | 12 |
|
13 | 13 | ## Naming style
|
14 | 14 |
|
15 |
| -OpenVINO has a strict rules for naming style in public API. All classes should be started from capital letter, methods and functions are named in `snake_case` style. |
16 |
| -To check the naming style `ncc` tool is integrated inside the OpenVINO. The detailed information about naming style can be found in the [configuration file](../../cmake/developer_package/ncc_naming_style/openvino.style). |
17 |
| -In order to activate this tool you need to have `clang` on the local machine and enabled CMake option `ENABLE_NCC_STYLE`. |
18 |
| -After that `ncc_all` target can be used to check the naming style. |
| 15 | +OpenVINO has strict rules for naming style in public API. All classes must start with a capital letter, and methods and functions should be named in `snake_case` style. |
| 16 | +To check the naming style, `ncc` tool is integrated in the OpenVINO. Read the detailed information about the naming style can be found in the [configuration file](../../cmake/developer_package/ncc_naming_style/openvino.style). |
| 17 | +To activate this tool, you need to have `clang` on the local machine and enable the CMake option `ENABLE_NCC_STYLE`. |
| 18 | +After that, you can use the `ncc_all` target to check the naming style. |
19 | 19 |
|
20 | 20 | ## See also
|
21 | 21 | * [OpenVINO™ README](../../README.md)
|
|
0 commit comments