3

私たちは開発チームであり、コードを文書化する必要があります。各開発者は、モジュールとして呼び出すことができるコードの一部に取り組みます。この仕様が記載されたドキュメントが必要です

  1. 実装と使用が簡単であること
  2. 各開発者は自分の作業を文書化し、別の開発者がモジュールについて知る必要がある場合、元の開発者に文書について尋ねる義務はありません。彼/彼女は自分でドキュメントを見つけることができるはずです.
  3. ドキュメント全体を検索できるはずです。

これについて何か提案はありますか？

4

2 に答える 2

4

ほとんどの言語には、コード コメントからドキュメントを作成する方法があります。Java と JavaScript のどちらにも、コメントを Java の Javadoc などの API 仕様に変換する方法があります。実際には、使用しているプラ​​ットフォームによって異なります。

于 2011-01-02T08:24:27.427 に答える
1

設計の決定、要件などについて話しますか?

このような共同作業に wiki (私たちは PmWiki を使用しています) を使用しませんか?

于 2011-01-02T10:29:27.220 に答える