![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
「[[Open棟梁 wiki>https://opentouryo.osscons.jp]]」は、「[[Open棟梁Project>https://github.com/OpenTouryoProject/]]」,「[[OSSコンソーシアム .NET開発基盤部会>https://www.osscons.jp/dotNetDevelopmentInfrastructure/]]」によって運営されています。 -[[戻る>設計のポイント]] *目次 [#xedebf30] #contents *概要 [#r9ec62d0] ドキュメント標準のポイント このあたりの情報ともマッチしているんじゃないでしょうか？ -拝啓『変わらない開発現場』を嘆く皆様へ ～エンプラ系 SI 開発現場の「今」を変えていくために～ | de:code 2016 | Channel 9~ https://channel9.msdn.com/Events/de-code/2016/CLT-016 --de:code 2016 「拝啓『変わらない開発現場』を嘆く皆様へ」を担当して – とあるコンサルタントのつぶやき~ https://blogs.msdn.microsoft.com/nakama/2016/06/16/decode-2016-clt016/ *ドキュメント標準化ワークフロー [#a20828be] 設計ドキュメントの標準化のためのワークフロー #ref(1.png,left,nowrap,１) *[[ドキュメンテーション>https://techinfoofmicrosofttech.osscons.jp/index.php?%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%86%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3]] [#l9a517a1] **[[ドキュメンテーション・ツール>https://techinfoofmicrosofttech.osscons.jp/index.php?%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%86%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%83%BB%E3%83%84%E3%83%BC%E3%83%AB]] [#w91b005c] -納品、保守用のプロダクト -マニュアル生成用のOSS -ソースコード解析ツール などは存在するが、~ リエンジ用のドキュメント生成用途にはあまり適合しない。 **[[設計書作成と作業形骸化>https://techinfoofmicrosofttech.osscons.jp/index.php?%E8%A8%AD%E8%A8%88%E6%9B%B8%E4%BD%9C%E6%88%90%E3%81%A8%E4%BD%9C%E6%A5%AD%E5%BD%A2%E9%AA%B8%E5%8C%96]] [#je628b67] Windows Forms, Web Formsなど -画面単位のモジュール化 -コンポーネントベース -イベント・ドリブン などを実現するフレームワークを活用する場合、詳細設計作業以降のモジュール設計作業の形骸化が発生することがある。~ （MVCなどの柔軟性の高いフレームワークを使用する場合、モジュール設計作業工程が重要になるケースもある。~ 大規模開発でMVCが標準のJavaを使用するケースなどでは、モジュール設計書から、スケルトンの自動生成をしている事が多い。） *処理説明のリバース出力 [#i5ffaa0d] -プログラム設計レベルのフローチャートでは、条件分岐数が多くなりすぎ、~ フローチャートを一見して、詳細設計内容を理解することは難しいと考える。 -このため、モジュールに詳細設計レベルの説明を付与するには、~ [[ドキュメンテーション・ツール>https://techinfoofmicrosofttech.osscons.jp/index.php?%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%86%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%83%BB%E3%83%84%E3%83%BC%E3%83%AB]]のメソッド中コメントを使用して、~ メソッド定義書の「処理説明」に詳細設計内容を出力すると良いと考える。 >※ メソッド中コメントが入っていないプログラムでは~ メソッド定義書の「処理説明」欄に詳細設計内容を出力できないので注意する。 **A HotDocument [#x795f6cb] -A HotDocumentのメソッド中コメントのコメント ルールは単純で、~ コメントを「///」で開始することでメソッド中コメントを記述でき、~ コメント文字「/」を１つ増やすことによって字下げが可能になっている。 -メソッド中コメント記述の際は、メソッド定義書に出力される~ 「処理説明」の見易さなどを意識する必要がある。 #ref(2-1.png,left,nowrap,２-１) ***サンプル プログラム [#b4ecd2e5] #ref(2-2.png,left,nowrap,２-２) ***Excel出力例 [#w44967bc] #ref(2-3.png,left,nowrap,２-３) ***HTML、ヘルプ ファイル出力例 [#mf86a168] #ref(2-4.png,left,nowrap,２-４) ***参考 [#j338eb56] https://techinfoofmicrosofttech.osscons.jp/index.php?%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%86%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%83%BB%E3%83%84%E3%83%BC%E3%83%AB **Doxygen [#b743524f] -/*! ～コメント～ */を使用すれば、メソッド定義書に出力できる。 -字下げは、HTML コマンド機能 を使用して代替できる。 --Doxygen > HTML コマンド~ http://www.doxygen.jp/htmlcmds.html -ただし、A HotDocumentと同様にメソッド中コメント記述の際は、~ メソッド定義書に出力される「処理説明」の見易さなどを意識する必要がある。 ***出力例 [#w44967bc] #ref(2-5.png,left,nowrap,２-５) ***参考 [#ga3ed4b0] https://techinfoofmicrosofttech.osscons.jp/index.php?%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%86%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%83%BB%E3%83%84%E3%83%BC%E3%83%AB *進捗の管理方法 [#a991f955] -[[設計書作成と作業形骸化>#je628b67]]で説明したような理由で、詳細設計作業以降の~ モジュール設計作業工程の成果物を作成しない場合、モジュール設計作業工程の進捗管理が困難になる。 -このため、モジュール設計作業工程で、[[ドキュメンテーション・ツール>https://techinfoofmicrosofttech.osscons.jp/index.php?%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%86%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%83%BB%E3%83%84%E3%83%BC%E3%83%AB]]を使用し、~ [[処理説明のリバース出力>#i5ffaa0d]]をさせれば、これをモジュール設計作業工程の進捗報告の元情報として代用できる。 #ref(3.png,left,nowrap,３)
