簡介這是一款專門用于軟件工程度量的代碼統(tǒng)計(jì)工具面向項(xiàng)目管理者與開發(fā)者可快速統(tǒng)計(jì)C、Java、Python、JavaScript等源碼的行數(shù)、注釋與空行從而量化開發(fā)工作量并輔助代碼質(zhì)量分析。壓縮包共45個文件約2.31MB主要包含可執(zhí)行的exe主程序、運(yùn)行所需的dll動態(tài)庫、多語言mo本地化文件、HTML報告模板、界面圖片與配置文件等解壓即可運(yùn)行。目前已有752人學(xué)習(xí)下載。工具支持按文件或類輸出統(tǒng)計(jì)報告并可基于環(huán)路復(fù)雜度評估維護(hù)難度有助于提前發(fā)現(xiàn)潛在問題附帶wxWidgets運(yùn)行組件、MinGW環(huán)境以及中/日文語言包適合需要建立輕量級代碼度量環(huán)境的團(tuán)隊(duì)或個人收藏使用。注意文中命令與參數(shù)以工具包內(nèi)自帶說明為準(zhǔn)如與你手上的版本存在差異以包內(nèi)文檔和幫助輸出為最終依據(jù)。這是這類統(tǒng)計(jì)工具的通用通病先寫在前面。1. 代碼統(tǒng)計(jì)工具 Source Counter它解決的不是數(shù)字而是口徑接手別人項(xiàng)目時最常遇到的一幕對方說「這個系統(tǒng)大概 6 萬行代碼」你打開工程一數(shù)好家伙13 萬行——差別大到?jīng)]法溝通。這不是誰在吹牛而是兩個人用了完全不同的統(tǒng)計(jì)口徑。代碼統(tǒng)計(jì)工具 Source Counter 解決的正是這個問題它把代碼行、注釋行、空行、混合行按一套固定規(guī)則拆開輸出一份可復(fù)現(xiàn)的報告讓你和別人說的是同一份數(shù)據(jù)。它是個免安裝的本地小工具雙擊能用也支持命令行批量調(diào)用適合三類人接外包要報工作量的人、寫論文或報告需要寫「項(xiàng)目規(guī)?！沟娜?、以及定期盤點(diǎn)內(nèi)部代碼庫的開發(fā)團(tuán)隊(duì)。這篇文章我會從統(tǒng)計(jì)口徑講到批量盤點(diǎn)腳本再把我踩過的五個坑完整擺出來。2. 統(tǒng)計(jì)口徑先行三類行數(shù)定義與 Source Counter 的關(guān)鍵參數(shù)先別急著雙擊運(yùn)行。任何統(tǒng)計(jì)工具給出的數(shù)字是否可信取決于你用什么口徑去要求它。我見過太多人拿到工具直接全盤默認(rèn)掃描出來的報表比自己拍腦袋猜的還離譜原因就是沒先想清楚「我要統(tǒng)計(jì)的是哪種行數(shù)」。2.1 三種行數(shù)定義物理行、邏輯行與有效代碼行的取舍行數(shù)的定義大致分三類。物理行Physical Lines是按換行符數(shù)的一段代碼寫成三行就是三行寫成一行就是一行完全取決于作者的書寫習(xí)慣——同一個文件換個格式化工具再跑數(shù)字可能立刻變了。邏輯行Logical Lines以語句為單位在 C 系語言里大致對應(yīng)分號但對 Python 這種縮進(jìn)敏感的語言判斷邏輯行的算法會復(fù)雜很多不同工具給出的結(jié)果差異極大。有效代碼行SLOCSource Lines of Code是大多數(shù)人真正想看的「到底寫了多少有效代碼」但它的統(tǒng)計(jì)恰恰是最難的注釋里的行算不算、空行算不算、只有大括號的行算不算各工具口徑五花八門。Source Counter 這類本地統(tǒng)計(jì)工具實(shí)際做法是把文件拆成幾個字段來報總行數(shù)、代碼行、注釋行、空行、混合行。這個「混合行」值得單獨(dú)說——它指一行里既有代碼又有注釋的行。很多工具不拆這一列而是直接把帶注釋的整行歸進(jìn)代碼行或者整行算成注釋行兩種處理都會讓最終數(shù)字偏差 5% 到 15%。所以我拿到一個統(tǒng)計(jì)工具第一件事不是看它能統(tǒng)計(jì)多少種語言而是看它怎么處理混合行。2.2 擴(kuò)展名與注釋規(guī)則讓工具認(rèn)識你的項(xiàng)目語言第二步是配置擴(kuò)展名和注釋規(guī)則。默認(rèn)情況下統(tǒng)計(jì)工具內(nèi)置了一批常見語言的映射關(guān)系但真實(shí)項(xiàng)目里總有例外比如.jsx和.tsx文件可能沒有被識別成前端代碼.vue單文件組件里混著 HTML、JS、CSS 三種片段.sql腳本里注釋用的是--而不是//。如果擴(kuò)展名沒映射對那這個文件要么整個被跳過要么被當(dāng)成純文本逐行數(shù)一遍統(tǒng)計(jì)結(jié)果當(dāng)然失真。我一般會先建一個配置文件把語言、擴(kuò)展名、注釋符號、排除目錄全部固定下來而不是每次手動勾選。以下是這類工具里很常見的配置寫法原理是通用的鍵名在不同版本里略有差別但思路一致; Source Counter 配置示例統(tǒng)計(jì)口徑全部固定在這里 extensions.c,.h,.cpp,.hpp,.java,.py,.js,.ts,.jsx,.tsx,.go,.sql,.sh block_comment/* */ # -- // formatternone filter_excludenode_modules;build;dist;.git;third_party;venv read_encodingauto report_formatcsv report_detailfile,language,code,comment,blank,mixed,total幾個關(guān)鍵鍵要理解別照抄就完事。extensions決定哪些文件參與統(tǒng)計(jì)漏了.vue或.sql這類文件會被無視block_comment列的是多行注釋和行注釋的符號Python 的#、SQL 的--、C 系的//都要寫進(jìn)去filter_exclude相當(dāng)于統(tǒng)計(jì)黑名單node_modules和build這類目錄不排除結(jié)果會虛高到?jīng)]法看read_encoding建議設(shè)成auto讓工具自動探測編碼——至于不設(shè)這個值會翻什么車我在第四章詳細(xì)說。下表是我自己常用的一套語言與擴(kuò)展名對應(yīng)關(guān)系可以直接抄語言推薦擴(kuò)展名注意點(diǎn)C/C.c, .h, .cpp, .hpp頭文件里可能混入大量宏定義Python.py配置.pyi存根文件是否統(tǒng)計(jì)前端三件套.js, .ts, .jsx, .tsx壓縮過的.min.js建議排除SQL.sql留意存儲過程里的注釋是--Shell.sh, .bash長段注釋有時用: EOF配置類.yml, .json, .toml默認(rèn)可不統(tǒng)計(jì)看你需求2.3 常用參數(shù)與選型理由為什么用本地工具而不是在線統(tǒng)計(jì)關(guān)于參數(shù)整理一份最常用的幾個按我自己的使用頻次排列--project指定要統(tǒng)計(jì)的根目錄--exclude排除目錄多個路徑用分號或逗號分隔--format指定輸出格式一般有txt和csv兩種批量盤點(diǎn)我建議用csv--output指定報表輸出路徑--encoding指定讀取源碼的編碼默認(rèn)是auto自動探測。前三個參數(shù)幾乎每次都要用后面兩個按需。選 Source Counter 而不是別的方式我的理由很簡單第一代碼不用上傳到任何線上服務(wù)本地跑完就完事遇到公司內(nèi)部項(xiàng)目沒有隱私顧慮第二它能把口徑固定成配置同一份配置下次還能復(fù)用第三批量盤點(diǎn)多項(xiàng)目時能走命令行接私活時一個腳本把所有客戶項(xiàng)目的代碼規(guī)模一次性拉出來。自己寫正則腳本統(tǒng)計(jì)行數(shù)看起來靈活但處理多行注釋嵌套、字符串里包含注釋符號這些情況時正則方案會無休止地吞邊界條件最后維護(hù)成本遠(yuǎn)超工具本身。2.4 先跑基線再看趨勢統(tǒng)計(jì)的兩種用法統(tǒng)計(jì)工具在實(shí)際使用中有兩種完全不同的用法很多人只用了第一種。第一種是「盤點(diǎn)現(xiàn)狀」就是跑一次看當(dāng)前代碼量多少用于報價、匯報、寫論文。第二種是「對比趨勢」同一份配置固定下來隔一段時間跑一次看代碼量增長了多少、注釋率是上升還是下降。第二種用法更有價值因?yàn)樗鼙┞俄?xiàng)目的真實(shí)健康度一個注釋率持續(xù)下降的項(xiàng)目往往意味著文檔正在腐化一個空行占比異常高的項(xiàng)目可能是某個同事把大段注釋刪光了只留空行。所以我建議你把配置文件當(dāng)作項(xiàng)目資產(chǎn)來管理放在倉庫的tools/目錄下而不是放在自己電腦的臨時文件夾里。這樣團(tuán)隊(duì)其他成員拉下來跑出來的數(shù)據(jù)和你在本地跑出來的完全一致。這一點(diǎn)做到位后面所有匯報都省去了解釋「你為什么和我數(shù)字不一樣」的功夫。3. 從解壓到批量盤點(diǎn)命令行跑統(tǒng)計(jì)與報表字段說明配置文件準(zhǔn)備好了工具也下載好了接下來就是實(shí)際操作。這一章涵蓋三個落地場景單項(xiàng)目統(tǒng)計(jì)、多項(xiàng)目批量盤點(diǎn)、以及拿到報表后怎么看。3.1 拿到工具包之后先看說明文檔再跑第一個命令下載解壓之后別急著雙擊主程序。先花兩分鐘看看包里的說明文件確認(rèn)主程序是圖形界面還是命令行工具以及支持哪些參數(shù)。不同版本的參數(shù)名可能有差異但幫助命令一般是通用的在終端里切到工具目錄運(yùn)行主程序并帶上--help或/help參數(shù)能列出全部可用選項(xiàng)。路徑方面有一個小坑如果項(xiàng)目路徑里帶空格命令行調(diào)用時要給路徑加引號否則工具會把路徑攔腰截?cái)鄨箦e。另外建議把工具解壓到一個固定的純英文路徑下比如D:\tools\sourcecounter\不要放在中文目錄里某些本地工具對路徑編碼處理不友好放在中文路徑下會出現(xiàn)不明所以的「文件打不開」錯誤。3.2 單項(xiàng)目統(tǒng)計(jì)從圖形界面到命令行圖形界面的操作流程通常是選擇根目錄、確認(rèn)擴(kuò)展名配置、點(diǎn)開始統(tǒng)計(jì)、查看結(jié)果、導(dǎo)出報表。第一次用圖形界面沒問題它能幫你直觀地看到每個文件夾的分布情況。但如果同樣的事情要做第二次就別再點(diǎn)界面了——命令行更穩(wěn)定不會因?yàn)槭只┻x某個目錄導(dǎo)致數(shù)字對不上。以下是我經(jīng)常用的一個單項(xiàng)目統(tǒng)計(jì)腳本#!/usr/bin/env bash # 單項(xiàng)目代碼統(tǒng)計(jì)固定配置、固定輸出位置 TOOL./sourcecounter PROJECT./src OUT./reports/project_size.csv $TOOL \ --project $PROJECT \ --exclude build,dist,third_party \ --format csv \ --output $OUT \ --encoding auto echo 統(tǒng)計(jì)完成報表輸出至 $OUT這個腳本的邏輯很直白第一段變量定義把工具路徑、項(xiàng)目路徑、輸出路徑集中放在一起換項(xiàng)目時只改變量不改命令第二段調(diào)用主程序四個參數(shù)分別指定項(xiàng)目根目錄、排除目錄、輸出格式、輸出路徑。排除目錄這里用逗號分隔多個目錄都能寫。--encoding auto是建議值讓工具自動探測源碼編碼避免手動指定錯了導(dǎo)致全盤亂碼。最后一行輸出提示信息方便在批量跑的時候知道每個項(xiàng)目是否完成。如果你是在 Windows 環(huán)境下把這段邏輯寫成count.bat即可參數(shù)本身不需要改動。順手提醒一句腳本里給路徑加引號是為了兼容帶空格的目錄比如E:\Work Projects\demo這類路徑不加引號必炸。3.3 多項(xiàng)目批量盤點(diǎn)一個腳本匯總所有客戶項(xiàng)目接外包或者做部門代碼盤點(diǎn)時你面對的往往不是單個項(xiàng)目而是十幾個甚至幾十個倉庫。逐個打開工具去選目錄效率太低了。更現(xiàn)實(shí)的做法是寫一個循環(huán)腳本把每個項(xiàng)目都統(tǒng)計(jì)一遍然后匯總成一張總表。下面這個腳本是我在盤點(diǎn)多個歷史項(xiàng)目時經(jīng)常用的核心思路是「遍歷目錄、逐個統(tǒng)計(jì)、統(tǒng)一收集」import subprocess import csv import os import glob tool rD:\tools\sourcecounter.exe # 工具實(shí)際路徑 projects_base rE:\works # 所有項(xiàng)目所在的根目錄 csv_paths [] for proj_dir in glob.glob(os.path.join(projects_base, *)): if not os.path.isdir(proj_dir): continue out_csv os.path.join(proj_dir, _size.csv) subprocess.run([ tool, --project, proj_dir, --exclude, build,dist,node_modules, --format, csv, --output, out_csv, --encoding, auto, ], checkTrue) csv_paths.append(out_csv)這段代碼先列出E:\works下的所有子目錄逐個調(diào)用統(tǒng)計(jì)工具生成_size.csv再把所有結(jié)果匯總。注意兩個細(xì)節(jié)glob.glob通配符匹配到的是完整路徑判斷isdir是為了避免把單個文件也當(dāng)成項(xiàng)目目錄subprocess.run的checkTrue會讓腳本在某個項(xiàng)目統(tǒng)計(jì)失敗時立刻報錯而不是帶著殘缺數(shù)據(jù)繼續(xù)跑——批量處理時及早暴露錯誤比事后排查更省時間。匯總步驟再往下就很簡單了用 Python 的csv庫把所有_size.csv讀進(jìn)內(nèi)存每行加上項(xiàng)目名寫入一個summary.csv。寫到這一步時有個經(jīng)驗(yàn)之談輸出編碼用utf-8-sig而不是utf-8因?yàn)?Excel 打開無 BOM 的 UTF-8 文件會亂碼加了 BOM 就能直接雙擊查看。以下是匯總部分rows [] for path in csv_paths: with open(path, newline, encodingutf-8) as f: for row in csv.DictReader(f): project_name os.path.basename(os.path.dirname(path)) row[project] project_name rows.append(row) fieldnames list(rows[0].keys()) with open(summary.csv, w, newline, encodingutf-8-sig) as f: writer csv.DictWriter(f, fieldnamesfieldnames) writer.writeheader() writer.writerows(rows)3.4 報表字段怎么看區(qū)分「代碼行」與「總行數(shù)」拿到 CSV 報表之后每個文件的字段大致是這些文件路徑、語言、代碼行、注釋行、空行、混合行、總行數(shù)。匯報時最常混淆的是「總行數(shù)」和「代碼行」對外報項(xiàng)目規(guī)模時我會優(yōu)先用代碼行而不是總行數(shù)——總行數(shù)里摻著注釋和空行別人無法判斷你到底寫了多少有效代碼對內(nèi)看代碼質(zhì)量時注釋行和注釋率就更值得關(guān)注。比如一個項(xiàng)目總行數(shù) 5 萬代碼行 3.2 萬注釋行 0.9 萬空行 0.9 萬注釋率約 22%這個比例在業(yè)務(wù)系統(tǒng)里算健康。如果注釋率低于 10%要么項(xiàng)目太新還沒開始寫注釋要么注釋習(xí)慣很差?？招姓急冗^高則往往意味著代碼被拆得零碎或者大量無用代碼被注釋后沒刪干凈。這些解讀比單純報一個數(shù)有用得多也更能體現(xiàn)統(tǒng)計(jì)的價值。4. 常見問題避坑統(tǒng)計(jì)結(jié)果偏差的五個真實(shí)來源這章是全文最想讓你認(rèn)真看完的部分。以下五個坑我都真實(shí)踩過每一條都會讓統(tǒng)計(jì)結(jié)果偏得離譜而且表面上看不出任何報錯。4.1 編碼問題中文注釋變成亂碼注釋行數(shù)忽高忽低現(xiàn)象同一個項(xiàng)目在 Windows 上統(tǒng)計(jì)注釋行數(shù)和在 Mac 上統(tǒng)計(jì)的結(jié)果不一樣打開報表看到某些文件的注釋行數(shù)是 0但源碼里明明有大段中文注釋。原因源碼文件是 UTF-8 編碼但沒有 BOM 頭而工具在 Windows 下默認(rèn)按本地編碼常見是 GBK去讀。中文字符被解釋成亂碼后注釋起始符號可能被拆壞導(dǎo)致整段注釋沒被識別于是注釋行統(tǒng)計(jì)為 0甚至亂碼內(nèi)容被當(dāng)成代碼行計(jì)入。這會讓代碼行虛高、注釋行虛低。解決配置文件里把read_encoding設(shè)為auto讓工具自動探測編碼如果項(xiàng)目里混著 GBK 和 UTF-8 兩種編碼文件auto也可能失效此時只能把兩種編碼的文件分開目錄統(tǒng)計(jì)。最徹底的做法是統(tǒng)一項(xiàng)目編碼用編碼轉(zhuǎn)換工具把所有源文件轉(zhuǎn)成 UTF-8 with BOM一勞永逸。4.2 注釋誤判正則表達(dá)式和 URL 里的 // 被當(dāng)成注釋現(xiàn)象一個 JS 文件里有一堆正則和 URL統(tǒng)計(jì)出來的注釋行數(shù)明顯高于實(shí)際寫的注釋。原因統(tǒng)計(jì)工具對注釋的識別大多基于字符串掃描會把const url https://example.com里的兩個斜杠識別成行注釋起始符或者把正則表達(dá)式/\d/當(dāng)成注釋塊。字符串感知能力弱的工具在這一類文件上幾乎必然誤判。解決先看報表里的「混合行」或「注釋行」列找出注釋行占比異常高的文件人工打開抽查。如果確認(rèn)是字符串誤判換一個支持詞法分析的工具模式重新統(tǒng)計(jì)如果換不了就在配置里把這類文件排除用別的方式單獨(dú)評估。還有個大坑是塊注釋不閉合一個 C 文件里寫了/*忘記收尾后面幾百行全部變成注釋導(dǎo)致代碼行為 0這種翻車很難一眼發(fā)現(xiàn)但通過對比相鄰版本的統(tǒng)計(jì)結(jié)果能快速定位。4.3 過濾規(guī)則失控node_modules 和 build 目錄沒排除現(xiàn)象統(tǒng)計(jì)一個前端項(xiàng)目總行數(shù) 20 萬打開報表一看光node_modules就占了大半或者統(tǒng)計(jì)一個 Java 項(xiàng)目build 目錄下生成的代碼全被算了進(jìn)去。原因配置里的filter_exclude沒有覆蓋依賴目錄和生成目錄。很多人第一次跑統(tǒng)計(jì)時只選了項(xiàng)目根目錄沒配排除項(xiàng)依賴包里的代碼全部被當(dāng)成項(xiàng)目源碼。解決默認(rèn)排除清單建議包含這些node_modules、build、dist、target、.git、vendor、third_party、venv。如果是 Git 管理的項(xiàng)目另一個更實(shí)用的做法是直接對比兩次提交之間的變更量用git diff統(tǒng)計(jì)增刪行數(shù)這比統(tǒng)計(jì)全量代碼更能反映一個迭代周期的工作量。4.4 換行符與空行同一文件兩次統(tǒng)計(jì)結(jié)果不一樣現(xiàn)象同一個文件第一次統(tǒng)計(jì)空行 200 行代碼格式化后再統(tǒng)計(jì)變成 150 行或者同事在 Windows 上改過的文件空行數(shù)突然變化。原因換行符不一致。Windows 用 CRLFLinux/Mac 用 LF。某些統(tǒng)計(jì)工具把\r\n算成兩個字符導(dǎo)致帶回車符的空行被識別為「有內(nèi)容的行」而不是空行文件末尾如果多一個換行符部分工具也會把那個位置多算一行。解決項(xiàng)目內(nèi)統(tǒng)一換行符用.editorconfig或.gitattributes固定統(tǒng)計(jì)前先跑一次格式化工具比如前端項(xiàng)目的 Prettier把所有文件換行符統(tǒng)一后再統(tǒng)計(jì)。如果只是臨時對一下數(shù)字可以接受小幅度偏差但如果是季度之間的趨勢對比換行符不統(tǒng)一會讓數(shù)據(jù)失真到?jīng)]法用。4.5 多工具對不齊不同工具統(tǒng)計(jì)結(jié)果相差 30% 以上現(xiàn)象用 Source Counter 統(tǒng)計(jì)是 5 萬行用另一個在線統(tǒng)計(jì)工具統(tǒng)計(jì)是 8 萬行兩個數(shù)字差出一個數(shù)量級誰都說服不了誰。原因這幾乎是必然的。不同工具的統(tǒng)計(jì)口徑差異極大有的把空行算進(jìn)代碼行有的把混合行拆開分別計(jì)有的包含注釋頭尾標(biāo)記行有的把import語句分行計(jì)。工具之間對語言邊界和擴(kuò)展名的判斷也不同所以對不齊才是常態(tài)。解決選定一個工具就固定下來所有匯報、論文、報價都從同一份配置出發(fā)并在匯報材料里注明「統(tǒng)計(jì)工具、口徑、排除目錄」這一行說明。當(dāng)別人拿著不同數(shù)字來質(zhì)疑時不需要爭論誰對誰錯直接把配置文件和報表甩給他讓他用同一份配置重跑一遍。做到這一步統(tǒng)計(jì)數(shù)字的「黑匣子」性質(zhì)就基本消失了。5. 把統(tǒng)計(jì)變成固定習(xí)慣規(guī)模估算與可復(fù)現(xiàn)的統(tǒng)計(jì)腳本統(tǒng)計(jì)工具學(xué)到這最后一層是把它變成工作習(xí)慣而不是偶爾想起來才跑一次。兩個小技巧分享給你。第一個是把行數(shù)換算成工作量時別只看總行數(shù)。常見的參考區(qū)間是業(yè)務(wù)系統(tǒng)平均每人每天有效代碼 150 到 400 行不含測試代碼注釋和空行大概要再放寬 30% 到 50%。如果你的統(tǒng)計(jì)報告里代碼行是 3 萬行按這個區(qū)間倒推單人開發(fā)大約需要 75 到 200 個工作日。這個區(qū)間跨度很大能輔助判斷一個需求是不是要延期但下單報價還是得結(jié)合業(yè)務(wù)復(fù)雜度行數(shù)只負(fù)責(zé)提供邊界參考。第二個是固定一份可復(fù)現(xiàn)的統(tǒng)計(jì)腳本放進(jìn)項(xiàng)目倉庫的tools/目錄里。腳本內(nèi)容就是第三章的單項(xiàng)目統(tǒng)計(jì)邏輯固定工具路徑、固定配置、固定輸出目錄每次跑完把 CSV 提交到倉庫留檔。這樣做的價值在于三個月后任何人拉下倉庫跑一遍腳本得到的報表和今天完全一致——同一個項(xiàng)目在不同人手里統(tǒng)計(jì)出不同數(shù)字的爭論直接從源頭消失。我之前接手過一個歷史項(xiàng)目對方交接文檔里寫「核心模塊約 3 萬行」我跑完統(tǒng)計(jì)愣是沒找到這 3 萬行在哪。后來把排除目錄和擴(kuò)展名配置調(diào)了一遍發(fā)現(xiàn)真正的有效代碼是 1.1 萬行另外 1.9 萬行是自動生成的代碼和拷貝進(jìn)來的第三方庫。對方的「3 萬行」沒有錯我的「1.1 萬行」也沒有錯差的只是口徑。從那以后我每次接手新項(xiàng)目、接外包報價、或者季度末寫匯報都強(qiáng)制自己先跑一遍固定配置的統(tǒng)計(jì)腳本再開口談數(shù)字。數(shù)據(jù)有邊界才經(jīng)得起追問。希望這篇工具拆解和踩坑記錄能幫到你。本文還有配套的精品資源點(diǎn)擊獲取