開発ドキュメント

私たちは開発チームであり、私たちのコードを文書化する必要があります。各開発者は、モジュールと呼ばれるコードの一部で動作します。我々は彼女/彼自身の作品開発ドキュメント

各開発者のドキュメントを実装し、使いやすくする必要がありますし、他の開発者が任意のモジュールについて知る必要がある場合、彼/彼女は「shouldnこの仕様

ご意見はありますか？

2011-01-02 user560224

これは本当に言語エコシステムに依存します。言語および/またはプラットフォームを指定すると、より良い回答が得られる可能性があります。また、「付随的な」ドキュメンテーションの生成、取り扱い、保管戦略も考慮する必要があります。 –

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

2011-01-02 08:24:27 jmort253

実際。同じことがVS/.NET、Scala、Perl、Python、Rubyなどにも当てはまります。言語とエコシステムは、「容認された」（使いやすい）ツールが果たす役割に本当に関わっています。 –

デザインの決定、要件などについてお話しますか？

このようなコラボレーションにwiki（PmWikiを使用）を使用してみませんか？

2011-01-02 10:29:27 mtraut

答えて