10

SO https://stackoverflow.com/questions/9475795/how-do-you-share-code-across-teams-working-on-very-different-projectsで同様の質問がありましたが、私のものは書くことですドキュメンテーション。

シナリオ：

私のチームが、Fancy-Word-Art (MS Office の word Art のような) と呼ばれる機能を備えた、Fany-WordPad のようなアプリケーションであるソフトウェア プロジェクトに取り組んでいるとします。ここで、メイン ウィンドウのコードを作成しました (.Net で WPF を使用するか、Java で Window Builder を使用するかは、どのツール/言語でもかまいません)。

同僚の Spongebob 氏が Word-Art 部分を書いている場合、ウィンドウに描画するためにどの関数を呼び出すか、どの Api を使用するかを彼にどのように伝えますか? つまり、スポンジボブ氏に、GetWindow() メソッドを呼び出して描画面への参照を取得する必要があること、渡す必要のあるパラメータなどを知らせるにはどうすればよいでしょうか?

ここで明確であることを願っています。これは手順ですか？

ステップ 1 :会社の Wiki サイトを使用して、同僚が作成したコードを理解する

ステップ 2 :GetWindow()プロジェクトの残りの部分でうまく機能するようにメソッドを作成する

ステップ 2 :イントラネットに wiki を配置して、メソッド パラメーター/メソッドのデータ型要件を指定するGetWindow()か、以下に示すように Doxygen/Confluence を使用します。

ステップ 3 :今度はあなたの同僚であるスポンジボブ氏の頭の痛い問題です。

これは正しく聞こえません..機能がたくさんあるので、Spongebobの人生は私のように大変です。私たち二人は、自分たちの仕事をするのに適切な関数を見つけるためにドキュメントを探し回っています。次に変更するとどうなりGetWindow() to GetWindow(string title)ますか.. さてliterally tell、彼がコードをやり直す必要がある貧しいスポンジボブはどうすればよいでしょうか。

ここで何か不足していますか？あなたの経験を共有してください。実際のソフトウェア ハウス環境でこの問題にどのように取り組んでいますか? あなたの仲間の開発者が次のテーブルにいる場合、彼らが行き詰まったときに特定のメソッドを実装する方法を実際に示しますか、またはこの状況にどのように対処しますか? ありがとうございました

ありがとう

4

8 に答える 8

6

良い質問です。もちろん、私は普遍的な解決策を持っていません。msdn/sun スタイルのコード ドキュメントは良いベースです。しかし、コンセプト、アーキテクチャなどについては、これ以上のものが必要です。一部のプロジェクトでは、そのために wiki を使用しています。お客様のご要望に応じて、ソリューションへの (コードなしの) 情報も保存する一種のチケット システムを用意しています。全体として、すべてのドキュメンテーションの中心となる場所はありません。

編集:自分のコードは多くの場合、最良のドキュメントです。クリーンなコードのガイドラインに従うか、他の何かが実際のベストプラクティスです:-)

于 2013-04-27T10:37:37.440 に答える
0

ばかげているように聞こえますが、私は彼（スポンジボブ）にメールを書くか、彼が必要なものを彼に伝えます. 近い将来、誰が何かを必要とするかをすでに知っている場合は、彼らが検索して頭を悩ませる前に、それらの人々に知らせることができれば素晴らしいことです. プロジェクトのすべてが技術的な解決策を必要とするわけではありません。多くの場合、人対人の方がはるかに優れています。

ドキュメンテーションを wiki に入れることもできます。そうすれば、Spongebob にリンクを送るだけで済みます。

于 2013-05-16T04:25:59.337 に答える