06
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
   

スポンサーサイト

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

[C# Advent Calender 2012]C#を補助するいろんな脇役

C# Advent Calender 2012の記事ですよ!

こういう技術系のイベント初めてだよーこわいよーぷるぷる でもでも前のまさる(高野将)さんにしっかりバトン渡されてしまったので頑張るのです!!

で、何をしようかなと考えたんですけど…
LINQ星人っていう宇宙からやってきた人たちが頑張ってるし…
かと言って技術的な内容は勝てるわけねーですしというわけで今回は

  1. C#のよく使うコードをタブ二つで挿入してくれる!コードスニペット
  2. わざわざ関数のところの説明を見に行かなくてもイイ!XMLドキュメントコメント
  3. ライブラリのドキュメント書くのめんどくさい貴方に!Sandcastle

っていうC#のっていうか.Net系を強力にサポートしてくれる子たちを紹介するのです。
え?C#じゃない?いやいやコード書くののサポートもC#のうちだって…
え?知ってる?使ってる?このイベントなら知らない人がいそうだったし!いたらぜひ使って欲しいし!
え?ライブラリ作らない?僕が使って超楽だったから!!

というわけでこのイベントに乗じて知らない人いたらいいなーってことで作業効率上げてくれる子たちを紹介するのです。
あ、ぼくはC#の開発にはよっぽどの事情がなければVisualStudio系列一択だと思ってますので。



コードスニペット

コードスニペットっていうのはよく使う似たようなコードを自動的に書いてくれる機能です。
たとえば、
  1. public int Value{ get; private set;}のようなプロパティ
  2. for(int i=0;i<n;i++){}のようなfor文(え、もう投げ捨ててますか?)
みたいなよく使いそうな小さなコードの断片を簡単に保管してくれる機能です。 使い方は propg.png
こんな風にスニペットの名前を書いてー
pt.png
Tabキー二回押したらこんなふうにひな形が出きて
end.png
黄色い部分はTab押すとそこにカーソルが移るのでそこを書き換えてあげればOK!

若しくは右クリックでスニペットの挿入でも選べます!

このスニペット自作も結構簡単です。
こんなかんじです。

ひな形から作っていけばかなり簡単に作れます。
追加の仕方とかはチュートリアル: コード スニペットを作成するが詳しいと思いますの。

XMLドキュメントコメント

Doxygenがデファクト!!っていうひといますがVSを使用している場合にはXMLドキュメントコメントの方がVS自体のサポートがあるので圧倒的に有利です。

XMLドキュメントコメントってのは summary.png これのことです
メソッドとかプロパティとかの上に
///って/三個定義が終わったあとに書くと
/// <summary>
///
/// </summary>
/// <param name="name"></param>
こんなかんじでひな形が出てきます。
なので
/// <summary>
/// ここにメソッドとかの説明 /// </summary>
/// <param name="name">引数の説明</param>
/// <return>戻り値の説明</return>
みたいな感じで書いくだけでOKです。 これがなんで便利かって言うと。 inter.png こんなかんじでコメントに書いた説明文が出てきます。 万が一忘れても関数名見ただけで機能がわかる方がベターなのですが書いたほうが万が一わからなくなってもすぐに見返せるのです。これはわりと嬉しいのです。

sandcatsle

sandcatsleとはライブラリ公開した!

でもでもドキュメント作るの面倒臭いっていう人ていうかドキュメント作るよって人のツールです。

必要なもの
  1. XMLドキュメントコメント
  2. sandcastle
  3. Sandcastle Help File Builder
です。

まずC#のXMLドキュメントコメントからXML文書を取ってきます。 gxml.png こんなかんじでXMLドキュメントファイルにチェックして保存先入れてあげてコンパイルするだけで簡単にxmlファイルができます。
XMLドキュメントコメントかいてれば!
書いてない場合大量の警告がとっととコメント書けって言ってきますのでちゃんとかきましょう。
次にSandcastle Help File Builderを立ち上げると sc1.png こんなのが出てくるので赤丸のアイコンクリックしてプロジェクト適当に保存してください。 sc4.png
そうするとこんな画面になると思うので主に太字の部分編集してください。

次に sc5.png
こんなかんじで
  1. Documentation Sourceにドキュメント化するバイナリとxml
  2. Referencesにドキュメント化するバイナリが参照しているdll
を入れてあげてDocumentation → Build Projectでドキュメント化することができます。

でできたのが例えばこんなかんじなわけです。(ドキュメントの内容は僕のライブラリの奴です。ちなみにエラーも結構出てますがキニシナイキニシナイ(体力つきた))
以上[C# Advent Calender 2012]なのにC#のコード自体には全く触れなかったけどでもでもC#のコードは出てるよ!!的な記事でした。

というわけで次は@masakにバトンタッチなのです!
スポンサーサイト

Comment

Secret

検索フォーム

RSSリンクの表示

リンク

リンクというか個人的によく使うアルゴリズムの解説サイト… C#でなかったりする

ブロとも申請フォーム

この人とブロともになる

QRコード

QRコード
上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。