bonnes-pratiques-programmation

コードを書くことと、良いコードを書くことには違いがあります。コードがあなた自身、あなたのチーム、さらにはそれを見た見知らぬ人にとっても読みやすく、理解できるものであることを確認することが重要です。考慮すべきプログラミングの実践方法をいくつか示します。

コメントを使用する

コメントは些細なように見え、書くのが面倒かもしれませんが、便利です。コメントはグループ プロジェクトで特に役立ちます。これは、あなたや他の人がコードのセクションの役割を思い出すのに役立ちます。これにより、全体的な可読性も向上します。

適切なエディタを使用する

メモ帳は正当な理由で嫌われています。コードを書きたい場合は、適切なソフトウェアを使用してコードを作成することもできます。適切なエディターを使用すると、読みやすさとデバッグ オプションが向上します。 VS Code、E などのオプションを検討してください。クリップ、アトム、メモ帳++そして崇高。

変更を常に保存する

何が起こるかわかりません。システムがクラッシュし、すべての作業内容が失われる可能性があります。使用を検討してくださいギットハブコードをオンラインに保存するには。そして常に変更を検証するようにしてください。タスクを完了し、何かが問題なく動作したら、それを保存します。

記述変数

変数に名前を付けて宣言するのは簡単な作業のように思えるかもしれませんが、実際はそうではありません。使用するのに最適な変数名を見つけるのに何分も費やすことになるでしょう。 var1、var2 などの名前は避けてください。その代わりに、より説明的な変数を取得します。テーブル、学生、名前、性別などの説明的な変数を使用します。

コードを確認すると、各変数が何に使用されているかをすぐに理解できます。当然のことながら、変数の説明が長くて退屈になる場合があります。常にできるだけ短く、説明的なものにするようにしてください。

ドキュメント

自分の仕事を文書化するのは恐ろしい仕事です。しかし、それをしなければなりません。あるいはそうすべきです。コード内コメントや説明変数を使ってコードで使用するすべてを説明できる自己文書が適切な場合もあります。ドキュメントではこれすべてが説明されているわけではありません。

システム要件や設計などを説明するために、別のファイルを作成する必要がある場合があります。

それはうまくいきますか？彼に触れないでください

コードがエラーなくコンパイルされたら、コードに触れたり変更したりしないでください。または、少なくとも、エラーのないコードのコピーを最初に保存してください。物事を改善しようとしていると思っていても、まったく逆のことをしている可能性があります。バグがないときにバグを作成しないでください。また、間違っている場合に備えて、いつでも「」を使用できることを覚えておいてください。Ctrl + Z»。

結論

経験豊富なプログラマが理想的だと考える実践方法は他にもあります。また、上記のヒントは必要ないと言う人もいるでしょう。誰もが自分の意見を持つ権利があります。

コメントや記述変数などのルールに従うことを強制される人はいません。しかし、これらに従うと、コーディングがいかに簡単になるかがわかります。