Средство проверки соглашений об именах C/C++ (ncc)
ncc — это инструмент разработки, помогающий программистам писать код C/C++, соответствующий некоторым соглашениям об именах. Он автоматизирует процесс проверки кода C/C++, чтобы избавить людей от этой скучной (но важной) задачи. Это делает его идеальным для проектов, которые хотят обеспечить соблюдение стандарта кодирования.
Следующие пакеты являются необходимыми для работы с инструментом ncc. Обратите внимание, что Python 'clang' предоставляет привязки Python для libclang. Версия clang должна соответствовать версии libclang.so в вашей системе.
pip install clang
pip install pyyaml
В Microsoft Windows установите 32-разрядную версию цепочки инструментов компилятора LLVM.
ncc . py [ - - help ] [ - - recurse ] [ - - style STYLE_FILE ] [ - - cdbdir CDBDIR ] [ - - dump ]
[ - - output OUTPUT ] [ - - filetype FILETYPE ] [ - - exclude EXCLUDE [ EXCLUDE ...]]
[ - - path PATH [ PATH ...]] [ - - include INCLUDE [ INCLUDE ...]]
[ - - definition DEFINITION [ DEFINITION ...]] [ - - clang - lib CLANG_LIB ]
Подробное описание всех опций:
ncc . py - - help
Чтобы распечатать все правила:
ncc . py - - dump
Стиль конструкций c/c++ определяется регулярными выражениями. Например, в приведенных ниже правилах говорится, что структура может иметь любой символ, имя класса должно начинаться с «C», переменная-член класса должна начинаться с m_, а имя функции должно начинаться с прописной буквы алфавита.
ClassName : ' C.* '
CppMethod : ' [A-Z].* '
VariableName :
ScopePrefix :
Global : ' g_ '
Static : ' s_ '
ClassMember : ' m_ '
DataTypePrefix :
String : ' str '
Pointer : ' p '
Integer : ' n '
Bool : ' b '
Pattern : ' ^.*$ '
./ncc.py --style examples/ncc.style --path examples/test.cpp
examples/test.cpp:16:7: " B " does not match " ^C.*$ " associated with ClassName
examples/test.cpp:28:9: " b " does not match " ^m_.*$ " associated with ClassMemberVariable
examples/test.cpp:31:5: " main(int, const char **) " does not match " ^[A-Z].*$ " associated with FunctionName
Total number of errors = 3
./ncc.py --style examples/ncc.style --recurse --exclude * .cpp * .h --path examples
examples/test.hpp:4:7: " Test " does not match " ^C.*$ " associated with ClassName
examples/test.hpp:12:9: " t " does not match " ^m_.*$ " associated with ClassMemberVariable
examples/test.hpp:19:9: " _aaa " does not match " ^[a-z].*$ " associated with StructMemberVariable
examples/test.c:8:9: " _b " does not match " ^[a-z].*$ " associated with StructMemberVariable
examples/test.c:9:9: " _c " does not match " ^[a-z].*$ " associated with StructMemberVariable
examples/tmp/test.hpp:4:7: " Test " does not match " ^C.*$ " associated with ClassName
examples/tmp/test.hpp:12:9: " t " does not match " ^m_.*$ " associated with ClassMemberVariable
examples/tmp/test.hpp:19:9: " _aaa " does not match " ^[a-z].*$ " associated with StructMemberVariable
Total number of errors = 8
Copyright © 2018 Нитин Нелликунну
Распространяется по лицензии MIT (MIT).
Дэниел Дж. Хофманн