human
コードをレビューし、必要な最適化のタスクを与えられたときにどのようなガイドラインをフォローする必要がありますか
gpt
ガイドラインはあなたの言語によって異なる場合がありますが、ここにいくつかの一般的なルールがあります。
***コードが機能することを確認してください。**クラッシュしないだけでなく、人々が望むことを行うこと。これはテストで実行できます。
***コードが自己説明していることを確認してください。**誰かがそれを読んで何をするかを伝えることができるはずです。これは、名前が理にかなっているべきだということを意味します。
***良いドキュメントがあることを確認してください。多くのIDESでは、これらは誰かが関数を覆うたびにポップアップし、スフィンクスのようなドキュメンテーションジェネレーターでも使用されます。
***リンジターを使用してください。
***コードがそれほど複雑ではないことを確認してください。**一部のリンジターは複雑さを測定しますが、多くのブランチを使用して大規模な機能がある場合は、理解しやすい複数の関数に分割してメンテナンスに役立つはずです。
human
良いドキュメントと悪いドキュメントの例をいくつか挙げてもらえますか？
gpt
確かに、ここに良いドキュメントと悪いドキュメントの例がいくつかあります：

良いドキュメント：

`` python
def add（a、b）：
    "" "
    2つの番号を一緒に追加して、結果を返します。

    ：PARAM A：追加する最初の番号
    ：param B：追加する2番目の番号
    ：return：aとbの合計
    "" "
    a + bを返します
`` `

悪いドキュメント：

`` python
def add（a、b）：
    ＃この関数は2つの数値を追加します
    a + bを返します
`` `

最初の例では、Docstringは、関数の目的、それが取るパラメーター、およびそれが返すものに関する明確で簡潔な情報を提供します。これにより、誰かがコードを読み取ることなく機能を使用する方法を簡単に理解できます。

2番目の例では、コメントは関数に関する情報を提供しますが、ドキュストリングほど明確でも完全ではありません。また、一貫した形式には従いません。これにより、読み取りや理解が困難になる可能性があります。