『Visual C#実践講座』 1章 .NET FrameworkとC#プログラミング その1
今日は1章 .NET FrameworkとC#プログラミング の1節 Visual StudioとC#コーディング を読んでいく。
1 タブ表示かMDIか
補完機能が優秀なので、タブ表示でも問題ない
Ctrl + Tabにより、開いてるファイル一覧し切り替えできる
2 エディタ領域の広げ方
Alt + Shift + Enter
3 行番号の表示
[オプション]→[テキストエディタ]→[C#]→[全般]
Ctrl + Gで指定行にジャンプできる
4 仮想空間モード
コメントを揃えて表示するための機能で、行末の空白をクリックするとそこに書ける
[オプション]→[テキストエディタ]→[C#]→[全般]
5 XML Document
ドキュメンテーションコメントをソースコードに書いた上で、
ドキュメント生成ツールであるNDocを使うと、見栄えのするドキュメントが出来るらしい。
このページが参考になりそう。
C# Tips −XMLドキュメントとNDoc−
http://www.divakk.co.jp/aoyagi/csharp_tips_ndoc.html
1. まず「ファイル」−「プロジェクトの追加」−「新しいプロジェクト」で「Visual C++プロジェクト」−「メイクファイルプロジェクト」を新規作成します。プロジェクト名は「Document」とかでいいでしょう。ディレクトリとかは適当に。
2. プロジェクトの新規作成時に出てくる「メイクファイル アプリケーション ウィザード」は全部デフォルトのまま「完了」で構いません。
3. そうするとソリューションエクスプローラに「Document」が追加されるはずですから、その「Document」を右クリックして「プロパティ」を開いてください。
4. プロパティのダイアログで「NMake」を選択して、「ビルド コマンドライン」に "NDocConsole.exe -project=test.ndoc" のようにNDocConsole.exeを起動するコマンドを入れてください。
5. ソリューションエクスプローラの「Document」の下にある「ソースファイル」「ヘッダーファイル」「リソースファイル」は邪魔であれば削除してしまっても構いません(もちろん、あっても構いません)。こうしておけば、ビルドするたびにドキュメントも生成されます。
NDOC日本語版 Project Top Page - SourceForge.JP
http://sourceforge.jp/projects/ndoc-jp/
これは便利そう。でも、.NET Framework2.0以降には対応してない。
次のページに強引に対応させる方法が書かれている。
failuresoft.com :: NDoc 1.3.1 - .NET 2.0 対応
http://www.failuresoft.com/report/ndoc/ndoc13_dotnet20
自作したクラスライブラリのヘルプ(ドキュメント)を作成する: .NET Tips: C#, VB.NET, Visual Studio
http://dobon.net/vb/dotnet/vs/commentwebreport.html
他にも、ドキュメント作成ツールはある。
以下は、参考にしたページ。
XMLドキュメントからMSDN風ライブラリ作成
http://social.msdn.microsoft.com/Forums/ja-JP/vbgeneralja/thread/d9b706d8-a881-4b53-899e-a20b620e13b1
自作したクラスライブラリのヘルプ(ドキュメント)を作成する: .NET Tips: C#, VB.NET, Visual Studio
http://dobon.net/vb/dotnet/vs/commentwebreport.html
まず、SandcastleというMicrosoftのツールがある。
次のリンクは、SandcastleのGUI版。便利らしい。
Sandcastle Help File Builder
http://www.codeplex.com/SHFB
それから、A HotDocumentという39800円のツールがある。
VB,VC++,C#,Java,Accessドキュメント自動生成ツール【A HotDocument】
http://www.hotdocument.net/
あと、doxygenというツールが有名らしい。