コードのドキュメントとユーザードキュメントの違い

Question

からLaTeX パッケージをパッケージ化する方法チュートリアル：

「パッケージの重要な部分は、コード、コードのドキュメント、およびユーザー ドキュメントです。」

コードのドキュメントとユーザードキュメントの違いは何ですか?

Answer 1

まあ、jjdb が次のように言ったにもかかわらず:

ユーザードキュメント = ユーザーガイド、コードのドキュメント = プログラマーズガイド

もう少し詩的に表現してみます。

ユーザー ガイドは、その名前が示すように、ユーザー、つまりコンピューターの前に座ってコードを使用して必要な作業を行う人が使用することを目的としています。

ドキュメント コードは、プログラマーが自分の作業を追跡し、コードに触れたい人に対して明確なメッセージを残し、精神の平静を保つ (特に、長期間コードに触れていなかった状態から戻ったとき) ために従う優れたプラクティスの一部です。

基本的に、ユーザー ドキュメントは、それを読んでいる人がパッケージをどの程度理解しているかがわからないため、できるだけ説明的である必要があります (これが最初のバージョンである場合、おそらく誰も見たことがないことに注意してください)。一方、コード ドキュメントは、コードが何を実行し、どこで実行しているかを示すように指向する必要があります。これにより、変更が可能な限り簡単に行えます。