Sprawdzanie stylu kodowania dla C

Question

Pracuję dla firmy, która ma ścisłe wytyczne dotyczące stylu kodowania, ale nie ma automatycznego narzędzia do ich sprawdzania. Rozejrzałem się i jedyne narzędzia, jakie mogłem znaleźć, to narzędzia przypominające strzępki, które wydają się mieć na celu sprawdzenie, co robi kod, i zapobieganie błędom, a nie upewnianie się, że styl kodowania jest poprawny.

Jakiego narzędzia powinniśmy użyć, jeśli w ogóle?

UWAGA: Szukam czegoś dla kodu C, chociaż coś, co działa na C++, również byłoby dobre.

Answer 1

Tradycyjny przyrząd upiększający indent, dostępny na każdej maszynie Unix. Wersja znaleziona na niektórych to GNU indent, którą można skompilować i zainstalować na każdym komputerze. tiret GNU potrafi czytać zbiór reguł z pliku ~/.indent.pro, na przykład:

--original --dont-format-first-column-comments --no-blank-lines-after-commas --parameter-indentation 8 --indent-level 8 --line-length 85 --no-space-after-parentheses --no-comment-delimiters-on-blank-lines 

Tak właśnie działa wcięcie przed popełnienia gwarantuje jednolitość prezentacji. Jeśli chcesz, aby wymusić na nim, zdefiniuj hak pre-commit w używanym systemie kontroli wersji, który będzie działał wcięciem i odmawiał zatwierdzenia, jeśli zatwierdzona wersja różni się od tworzonego wcięcia.

Answer 2

Poszukujesz "code beautifier". Uncrustify jest wolna.

Musisz tylko opisać swój styl kodowania w pliku konfiguracyjnym i upewnić się, że każdy plik pasuje do opisanego stylu.

Answer 3

Sprzeciwiam się użyciu formalnego narzędzia tutaj. Najlepsze egzekwowanie standardów kodowania to presja ze strony rówieśników. Wzajemna presja i wzajemny szacunek pomiędzy członkami zespołu są kluczowymi elementami tego środowiska budowania zespołu ... nie inaczej, niż dobre nękanie, które jest konieczne, gdy ktoś nieumyślnie "przerywa budowę", itp.

Przegląd nowszych członków zespołu "Kod jest kluczową częścią procesu uczenia się i integracji z zespołem oraz uczenia się standardów kodowania, itp. Jeśli standard kodowania jest zbyt skomplikowany lub subtelny, aby można go było pobrać w ten sposób, zamiast szukać narzędzia do sprawdzenia poprawności standard, powinieneś szukać nowego standardu kodowania.

Answer 4

Istnieje (lub było) wiele narzędzi do tego. Jednym z najstarszych jest cb (C Beautifier), który był wokół w dawnych wersjach systemu Unix - sposób, w tym przypadku, w wersji 7 Unix:

CB (1) UNIX Programmer’s Manual CB (1) 

NAME 
    cb – C program beautifier 
SYNOPSIS 
    cb 
DESCRIPTION 
    Cb places a copy of the C program from the standard input on the standard 
    output with spacing and indentation that displays the structure of the 
    program. 
BUGS 

GNU indent jest znacznie bardziej skomplikowany i konfigurowalny beastie. Były też narzędzia komercyjne. Na przykład, Abraxas Software zapewnia narzędzie CodeCheck, na przykład; użyliśmy tego krótko w połowie lat 90., ale zmiany, które chciały wprowadzić, były (bardzo konieczne, ale) zbyt nachalne dla zarządzania.

Answer 5

AStyle robi to, co chcesz:

artystyczny styl jest kod źródłowy wgłębnik, formater i beautifier dla C, C++, C# i języków programowania Java.

Dla Eclipse dostępny jest AStyle Plugin.

Eclipse ma również program do formatowania kodu, ale nie jestem pewien, czy działa on w CDT.

Answer 6

Z podobnego pytania: Vera++: "Vera ++ może służyć do wyszukiwania naruszeń stylu kodowania i konwencji." Istnieje bezpłatna edycja społecznościowa, a "wszystkie jej reguły są implementowane jako skrypty (Tcl), które mogą być modyfikowane lub dodawane przez użytkownika".

Answer 7

Użyj VIM i ciesz się łatwością. Możesz wykonywać wszystkie czynności związane z programowaniem źródłowym za pomocą prostych poleceń. Możesz także zwiększyć niezawodność i moc VIM, edytując plik .vimrc. Pomoc w tym pomoże ci bardzo.

/renjith g

Answer 8

Spróbuj UniversalIndentGUI, czyli owinięcie wokół GUI popularne wgłębników/beautifiers jak Uncrustify, stylu artystycznych, GNU wcięcie. Jego GUI i funkcja podglądu na żywo sprawiają, że bardzo łatwo wypróbować różne wcięcia, a kiedy już znajdziesz wgłębienie i konfigurację, którą ci się spodoba, możesz wyeksportować konfigurację lub nawet wyeksportować skrypt powłoki. Świetnie, jeśli nadal próbujesz.

Answer 9

Można użyć clang-format. Więcej informacji można znaleźć na oficjalnej stronie: http://clang.llvm.org/docs/ClangFormat.html