ガイドラインはあなたの言語によって異なる場合がありますが、ここにいくつかの一般的なルールがあります。
***コードが機能することを確認してください。**クラッシュしないだけでなく、人々が望むことを行うこと。これはテストで実行できます。
***コードが自己説明していることを確認してください。**誰かがそれを読んで何をするかを伝えることができるはずです。これは、名前が理にかなっているべきだということを意味します。
***良いドキュメントがあることを確認してください。多くのIDESでは、これらは誰かが関数を覆うたびにポップアップし、スフィンクスのようなドキュメンテーションジェネレーターでも使用されます。
***リンジターを使用してください。
***コードがそれほど複雑ではないことを確認してください。**一部のリンジターは複雑さを測定しますが、多くのブランチを使用して大規模な機能がある場合は、理解しやすい複数の関数に分割してメンテナンスに役立つはずです。
The guidelines may vary depending on your language, but here are a few general rules:
* **Ensure the code works.** Not just that it doesn't crash, but that it does what people want. This can be done with tests.
* **Make sure the code is self explaining.** Someone should be able to tell what it does by reading it over. This also means names should make sense.
* **Make sure there is good documentation.** There should be docstrings for functions and classes. In many IDEs, these will popup whenever someone hovers over a function, and they will also be used in documentation generators like Sphinx.
* **Use linters.** These tools will automatically tell you if the formatting is right, if things are too complex, etc.
* **Make sure the code isn't too complex.** Some linters will measure complexity, but if there are massive functions with many branches, breaking it up into multiple functions that are easier to understand should help with maintenance.