[翻訳] LLVMコーディング標準3.9.1（３/４）機械的なソースの問題 - Qiitaソースコードのフォーマット コメント コメントは、可読性と保守性について重要な部分のひとつです。皆さんご存知の通り、コードにはコメントすべきです。コメントを書く場合、適切な句読点と大小文字の英文で書きます。コードがなにを行おうとしているのか、またなぜ行おうとしているのかを記載することに焦点を絞り、微細に どうやるか を書くことは避けてください。ここでは、文書に重要な事柄がいくつかあります： ファイルのヘッダ すべてのソースファイルには、ファイルの基本的な目的を説明するヘッダが必要です。ファイルにヘッダがない場合、ツリーにチェックインしてはいけません。標準のヘッダは次のようになります： //===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===// // // The LLVM Compiler
![[翻訳] LLVMコーディング標準3.9.1（３/４）機械的なソースの問題 - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/8b885afffed7cada89edd4586afd91083deda568/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9JTVCJUU3JUJGJUJCJUU4JUE4JUIzJTVEJTIwTExWTSVFMyU4MiVCMyVFMyU4MyVCQyVFMyU4MyU4NyVFMyU4MiVBMyVFMyU4MyVCMyVFMyU4MiVCMCVFNiVBOCU5OSVFNiVCQSU5NjMuOS4xJUVGJUJDJTg4JUVGJUJDJTkzJTJGJUVGJUJDJTk0JUVGJUJDJTg5JUU2JUE5JTlGJUU2JUEyJUIwJUU3JTlBJTg0JUUzJTgxJUFBJUUzJTgyJUJEJUUzJTgzJUJDJUUzJTgyJUI5JUUzJTgxJUFFJUU1JTk1JThGJUU5JUExJThDJnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9NTYmcz1iZTkxYjllNTY3ZTk4NGQzNDU5MThjOGJiOTJlM2YyMg%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDB0ZW5teW8mdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT0zNiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPTlkYTZiZTk3ZWRiMWE1ODZmOWZkZDY4ODMwYzk0MDA0%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3Dff70913b56d42bb495bdd03f6f44751b)
