lint
lint とは、主にC言語のソースコードに対し、コンパイラよりも詳細かつ厳密なチェックを行なうプログラムである。静的解析ツールとも呼ばれる。以下に挙げるように、コンパイラではチェックされないが、バグの原因になるような曖昧な記述についても警告される。構文(シンタックス)レベルのチェックだけでなく、意味(セマンティクス)レベルのチェックまで実行するものもある。
- 型の一致しない関数呼び出し[要説明]
- printfなどにおける書式指定文字列と、対応する可変長引数の数および型の不一致
- 初期化されていない変数の読み取り参照がある
- 宣言されているが使われていない変数がある
- 代入などの書き込み参照はあるが読み取り参照のない変数がある
- 同じ関数を呼び出す複数のコードがあるが、その戻り値を使う場合と使わない場合がある
- 関数が戻り値を返す場合と返さない場合がある
- インデント規則に一貫性がないなどのスタイルの逸脱
lintは、もともと「糸くず」や「綿ぼこり」といった意味を持つ英単語である[1]。
lintで警告が出る例
[編集]int foo(int count) {
int sum = 0;
int i;
for (i = 1; i <= count; ++i) {
sum += i;
}
if (sum >= 100) {
return sum;
}
}
上記の例の場合、foo()
は、sum
が100以上であれば値を返すが、それ以外の時には値を返さない。これはC言語の構文的には合法だが、実行時エラーなどの未定義動作を引き起こす。そのため、lint では警告が出る。
ただ、最近[いつ?]のコンパイラは、細かな警告やエラーを出す機能が強化されているため、以前は lint を使わなければ検出できなかった類のミスも、コンパイル段階で検出できるようになっているものがある。上記の例は、Microsoft Visual C++では既定で C4715 の警告が生成され、コンパイルオプション/we"4715"
を指定することでコンパイルエラーになる。GCCやClangではコンパイルオプション-Wreturn-type
を指定することで警告が生成され、また-Werror=return-type
を指定することでコンパイルエラーになる。
後発のプログラミング言語では安全性を考慮して、上記のようなコードを常に非合法とし、必ずコンパイルエラーにしてしまう仕様となっているもののほうが多い。C言語およびC++では、仕様により動作が厳密に規定されていない事項(未規定動作、処理系定義動作、未定義動作)が非常に多く、そのためコンパイラやlintによる警告に頼らなければならないことが多い。
「lint」の派生用法
[編集]転じて、C言語に限らず、各種プログラミング言語で書かれたコードに対して構文チェックや静的解析を行なうプログラムも、lintと呼ばれるようになった。この意味でのlintの代表例としては、HTMLの構文チェックを行なうAnother HTML-lintがある。Android StudioではJavaおよびKotlinで書かれたコードに対して静的解析を実行するツールとしてlintが利用可能である[2][注釈 1]。
また、コードをチェック・解析する動作をlint/linting[4]、lintを行なうプログラムをlinterと呼ぶこともある[5]。ClangベースのC++ linterとしては、Clang-Tidyがある[6]。
コンパイラが存在する言語の場合、静的コード解析にコンパイラとlinterを併用することで、字句/構文チェックと意味論的チェックを実現できる。コードエディター上でリアルタイムに動作するlinterを利用すれば、コーディングしながら常時lintingを行なえる。例えばVisual Studio Code上でTypeScriptコードを書く場合、字句/構文チェックを担うtsserver
[注釈 2]とlintingを担うESLint
を用いてコーディング中に常時静的コード解析が走る状態を実現できる。モダンな統合開発環境では、名称は異なれど一般的に何らかの静的コード分析ツールが最初から組み込まれていて、問題のある個所をコードエディター上でハイライト表示したり、分析結果一覧をリスト表示したりする機能が標準的に利用できるようになっている[8]。
lintingを行なっても即座にバグが発見されるわけではない。lintingの主な目的は低品質コードの検出によるバグの予防である。言語構文に合致しているコードはコンパイルエラーにならないが、実行時エラーや意図しない動作、あるいはメンテナンス性や移植性の低下などの潜在的問題を引き起こす可能性のあるコードはlintエラーになることがある。また、linterの出す警告は一般的なコンパイラ警告よりも細やかな分析結果となる。linterは「エラーをしばしば引き起こすパターン[9]」あるいは「エラーを避けるベストプラクティスパターン[10]」を用いて品質の低いコードを検出する。検出された低品質コードを改善することにより、バグが埋め込まれる可能性を低減しバグを予防できる。
脚注
[編集]注釈
[編集]- ^ lint自身はJava/Kotlinで実装されている[3]。
- ^ Microsoft Windows用のMicrosoft Visual Studioにおける言語サーバープロトコル[7]に似たプロトコルでリアルタイム動作するTypeScriptコンパイラ/言語サーバー(Language Server)。VSCode組み込み。
出典
[編集]- ^ lintの意味・使い方・読み方|英辞郎 on the WEB
- ^ lint チェックでコードを改善する | Android デベロッパー | Android Developers
- ^ lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks - platform/tools/base - Git at Google
- ^ "lint/linting"の用例: Linting Python in Visual Studio Code - VSCode
- ^ "linter"の用例: ESLint - Pluggable JavaScript linter
- ^ Clang-Tidy — Extra Clang Tools
- ^ 言語サーバープロトコルの概要 - Visual Studio (Windows) | Microsoft Learn
- ^ マネージド コードのコード分析 - Visual Studio (Windows) | Microsoft Learn
- ^ Possible Errors: These rules relate to possible syntax or logic errors Rules - ESLint
- ^ Best Practices: These rules relate to better ways of doing things to help you avoid problems Rules - ESLint