Jako vývojář možná budete muset sdílet průběh a statistiky vašeho kódu se svým šéfem nebo kolegy. Váš šéf může chtít analyzovat kód a poskytnout jakékoli další vstupy. V takových případech je, pokud vím, k dispozici málo programů pro analýzu zdrojového kódu. Jedním z takových programů je Ohcount . Dnes jsem narazil na další podobnou utilitu, konkrétně "Cloc" . Pomocí Cloc můžete snadno spočítat řádky zdrojového kódu v několika programovacích jazycích. Počítá prázdné řádky, řádky komentářů a fyzické řádky zdrojového kódu a zobrazí výsledek v úhledném formátu tabulkových sloupců. Cloc je bezplatný, open source a multiplatformní nástroj napsaný v Perlu programovací jazyk.
Funkce
Cloc se dodává s řadou výhod, včetně následujících:
- Snadná instalace/použití. Nevyžaduje žádné závislosti.
- Přenosné
- Může vytvářet výsledky v různých formátech, jako je prostý text, SQL, JSON, XML, YAML, hodnoty oddělené čárkami.
- Může počítat vaše odevzdání git.
- Počítejte kód v adresářích a podadresářích.
- Počítací kódy počítají kódy v komprimovaných archivech, jako jsou tar balls, soubory ZIP, soubory Java .ear atd.
- Open source a multiplatformní.
Instalace Cloc
Nástroj Cloc je dostupný ve výchozích úložištích většiny operačních systémů podobných Unixu. Můžete jej tedy nainstalovat pomocí výchozího správce balíčků, jak je znázorněno níže.
Na Arch Linuxu a jeho variantách:
$ sudo pacman -S cloc
Na Debianu, Ubuntu:
$ sudo apt-get install cloc
Na CentOS, Red Hat, Scientific Linux:
$ sudo yum install cloc
Na Fedoře:
$ sudo dnf install cloc
Na FreeBSD:
$ sudo pkg install cloc
Lze jej také nainstalovat pomocí správce balíčků třetí strany, jako je NPM také.
$ npm install -g cloc
Počítejte řádky zdrojového kódu v mnoha programovacích jazycích
Začněme jednoduchým příkladem. Ve svém aktuálním pracovním adresáři mám program "ahoj světe" napsaný v C.
$ cat hello.c #include <stdio.h> int main() { // printf() displays the string inside quotation printf("Hello, World!"); return 0; }
Chcete-li počítat řádky kódu v programu hello.c, jednoduše spusťte:
$ cloc hello.c
Ukázkový výstup:
Odřízněte řádky v programu Hello World pomocí Cloc
První sloupec uvádí název programovacích jazyků, ze kterých se zdrojový kód skládá . Jak můžete vidět na výše uvedeném výstupu, zdrojový kód programu "hello world" je napsán pomocí C programovací jazyk.
Druhý sloupec zobrazuje počet souborů v jednotlivých programovacích jazycích . Náš kód tedy obsahuje 1 soubor celkem.
Třetí sloupec zobrazuje celkový počet prázdných řádků . V našem kódu nemáme žádné prázdné soubory.
Čtvrtý sloupec zobrazuje počet řádků komentářů .
A poslední a pátý sloupec zobrazuje celkový počet fyzických řádků daného zdrojového kódu .
Je to pouze 6řádkový kódový program, takže počítání řádků v kódu není velký problém. A co nějaký velký soubor zdrojového kódu? Podívejte se na následující příklad:
$ cloc file.tar.gz
Ukázkový výstup:
Počítání řádků v souboru tar
Podle výše uvedeného výstupu je poměrně obtížné ručně najít přesný počet kódu. Cloc však zobrazí výsledek během několika sekund v pěkném formátu tabulkových sloupců. Hrubý součet každé sekce si můžete prohlédnout na konci, což je docela užitečné, pokud jde o analýzu zdrojového kódu programu.
Cloc počítá nejen jednotlivé soubory zdrojového kódu, ale také soubory v adresářích a podadresářích, archivech a dokonce i v konkrétních git commitech atd.
Spočítejte řádky kódů v adresáři:
$ cloc dir/
Podadresář:
$ cloc dir/cloc/tests
Spočítejte řádky kódů v archivním souboru:
$ cloc archive.zip
Můžete také počítat řádky v úložišti git pomocí specifického potvrzení, jak je uvedeno níže.
$ git clone https://github.com/AlDanial/cloc.git
$ cd cloc
$ cloc 157d706
Cloc dokáže rozpoznat několik programovacích jazyků. Chcete-li zobrazit úplný seznam rozpoznaných jazyků, spusťte:
$ cloc --show-lang
Další podrobnosti naleznete v části nápovědy.
$ cloc --help