この質問にはすでに回答があります：
コメント
回答
文書化する必要があります：
および
なぜこのビットを最適化したのか、そのショートカットは正確には何であるか、期待する結果は何か、要件は何か、そこにある理由そもそも、このデータはどこに送信され、どこから入力を取得しますか、これがマルチスレッドの場合はモデルを説明し、データベースがある場合はスキーマ、リンク、理由を説明します…
明白なことを文書化しないでください。プレゼンテーションに関しては、これを行う方法はたくさんあります。私は個人的にインラインコメントが好きです（私は古い種類のプログラマーであり、当時は派手なツールがありませんでした。シンプルでわかりやすいと思います）。何か凝ったものが必要な場合は、時間をかけすぎないようにしてください。そうしないと、すぐに放棄する可能性が高くなります。
コメント
回答
2年以上前に書いた自分のコードをいくつか読んでください。
どのような種類のことが不明なのかを自問し、頭を悩ませてください。これらのタイプのもの（それらが何であれ、プログラマーによって異なります）は、開発する新しいコード、または書き換え/再利用する古いコードについて最初に文書化を開始したいものです。理解を遅らせるフォーマット、変更します。
または、2年以内に…
回答
必要なことの1つincludeは依存関係です。関数があそこの何かに依存している場合は、docそれが何であるか、あそこがどこにあるか、そしてその理由を説明します。
回答
PHPを使用しているため、 PHPDoc 開始するのに適した場所です。ソースでAPIドキュメントをインラインで作成し、同じ形式を使用してチュートリアルやユーザードキュメントを作成できます。また、出力形式に関してもある程度の柔軟性が得られます。
回答
私は常に、最初にコメントを書くことからコードを書き始めます。プログラムの流れを説明すると、コメントが必要なものとそうでないものがわかり始めます。 「コードの記述を開始したら、追加の説明が必要な部分を装飾し、自己文書化する部分を改良します。
各クラス、関数、またはメソッドが完了したら、戻ってコメントを追加します。 doxygenやPHPDocなどのドキュメントジェネレーターの場合。これにより、実際のAPIドキュメントが取得されます。
コードを使用するユーザーに応じて、操作ドキュメントの正式な説明をLaTeXまたはWordで記述します。
回答
Doxygenはほとんどの言語をカバーしています。構文を理解するのに少し時間をかける必要がありますが、大きな問題は何を文書化するかです。各関数をブラックボックスとして扱います。何が入り、何が出るかを文書化します。トラップするエラー、引数をnullにできるかどうかを文書化します。 nullを返すことができるかどうか。
覚えておいてください。ほんの数か月で、関数が一体何をするのか理解できなくなります。時間を節約しているだけです。