検索
リンク
タグ
ASP.NET
.NET
ASP.NET MVC
F#
Visual Studio
Azure
ASP.NET Core
ライトニングトーク
Plone
Selenium
AJAX
C#
jQuery
SQL Server
ADO.NET Entity Framework
JavaScript
WebMatrix
EFCore
LINQ
Fizz-Buzz
カテゴリ
最新の記事
最新のコメント
記事ランキング
最新のトラックバック
以前の記事
2024年 03月 2024年 02月 2024年 01月 2023年 12月 2023年 11月 2023年 10月 2023年 09月 2023年 08月 2023年 07月 2023年 06月 2023年 05月 2023年 04月 2023年 03月 2023年 02月 2023年 01月 2022年 12月 2022年 11月 2022年 10月 2022年 09月 2022年 08月 2022年 07月 2022年 06月 2022年 05月 2022年 04月 2022年 03月 2022年 02月 2022年 01月 2021年 12月 2021年 11月 2021年 10月 2021年 09月 2021年 08月 2021年 07月 2021年 06月 2021年 05月 2021年 04月 2021年 03月 2021年 02月 2021年 01月 2020年 12月 2020年 11月 2020年 10月 2020年 09月 2020年 08月 2020年 07月 2020年 06月 2020年 05月 2020年 04月 2020年 03月 2020年 02月 2020年 01月 2019年 12月 2019年 11月 2019年 10月 2019年 09月 2019年 08月 2019年 07月 2019年 06月 2019年 05月 2019年 04月 2019年 03月 2019年 02月 2019年 01月 2018年 12月 2018年 11月 2018年 10月 2018年 09月 2018年 08月 2018年 07月 2018年 06月 2018年 05月 2018年 04月 2018年 03月 2018年 02月 2018年 01月 2017年 12月 2017年 11月 2017年 10月 2017年 09月 2017年 08月 2017年 07月 2017年 06月 2017年 05月 2017年 04月 2017年 02月 2017年 01月 2016年 12月 2016年 11月 2016年 10月 2016年 09月 2016年 08月 2016年 07月 2016年 06月 2016年 05月 2016年 04月 2016年 03月 2016年 02月 2016年 01月 2015年 12月 2015年 11月 2015年 10月 2015年 09月 2015年 08月 2015年 07月 2015年 05月 2015年 04月 2015年 03月 2015年 02月 2015年 01月 2014年 12月 2014年 11月 2014年 10月 2014年 09月 2014年 08月 2014年 06月 2014年 04月 2014年 03月 2014年 02月 2014年 01月 2013年 12月 2013年 10月 2013年 09月 2013年 08月 2013年 07月 2013年 06月 2013年 05月 2013年 04月 2013年 03月 2013年 02月 2013年 01月 2012年 12月 2012年 11月 2012年 10月 2012年 09月 2012年 08月 2012年 07月 2012年 06月 2012年 05月 2012年 04月 2012年 03月 2012年 02月 2012年 01月 2011年 12月 2011年 11月 2011年 10月 2011年 09月 2011年 08月 2011年 07月 2011年 06月 2011年 05月 2011年 04月 2011年 03月 2011年 02月 2011年 01月 2010年 12月 2010年 11月 2010年 10月 2010年 09月 2010年 08月 2010年 07月 2010年 06月 2010年 05月 2010年 04月 2010年 03月 2010年 02月 2010年 01月 2009年 12月 2009年 10月 2009年 09月 2009年 07月 2009年 06月 2009年 05月 2009年 04月 2009年 03月 2009年 02月 2009年 01月 2008年 12月 2008年 11月 2008年 10月 2008年 09月 2008年 08月 2008年 07月 2008年 06月 2008年 05月 2008年 04月 2008年 03月 2008年 02月 2008年 01月 2007年 12月 2007年 11月 2007年 04月 2007年 03月 2007年 02月 2007年 01月 2006年 11月 2006年 10月 2006年 09月 2006年 08月 2006年 07月 |
2012年 12月 06日
※本稿は「Visual Studio Advent Calendar 2012」に向けての記事です。
Visual Stuido は 最強の JavaScript エディタである説自分は ASP.NET Webアプリ開発を仕事としていることから、主な開発環境はVisual Studio である。 さて、Web アプリ開発となると JavaScript のコードを書くことはまず避けられない。 しかし超強力な助っ人、Visual Studio がある。 Visual Studio の JavaScript コードに対する支援機能は凄まじいばかりである。 どこがどう凄いのか詳しい解説は今回は割愛するが、ASP.NET に限らず PHP でも Ruby でもなんでも、Windows OS 上で Web アプリ/サイト開発を行っているのなら、JavaScript エディタとしてだけでも Visual Studio を使うことをお勧めしたいくらいである。 ※Visual Studio にはいくつか機能別にラインナップがあり、一番廉価な Express 版は \0 である。にも関わらず、有償である上位エディションと同じ JavaScript エディタ機能がついてくる。 さて今回は、そんな Visual Studio JavaScript エディタの支援機能のひとつ、XML ドキュメントコメントによるツールヒントについて触れておく。 XML ドキュメントコメントVisual Studio で、例えば jQuery を利用した JavaScript コードを編集していると、インテリセンスでメンバ候補が列挙されるのに加え、ツールヒントも表示される。これがあるので、もういちいちマニュアルやオンラインヘルプを参照しなくなってしまった。 この仕掛けの背後にあるのが XML ドキュメントコメントだ。 JavaScript の関数内に、3連スラッシュで始まるコメント以降に <summary> ~ </summary> など所定の XML 書式で、その関数の説明文や、各引数の型や説明を書いておく。 すると、この3連スラッシュの特殊なコメントを Visual Studio が背後で読み取っていて、ツールヒントの表示を行ってくれるわけだ。 そして、引数や戻値の「型」も書けることからわかると思うが、ツールヒントの表示だけでなく、インテリセンスによるメンバの表示にも一役買っている。 function foo(a, b){...} というコードがあったとして、関数 foo の内部を記述しているとき、引数 a に渡されるオブジェクトが、文字列であるという仕様なのか、日付型であるという仕様なのかは、動的言語たる JavaScript では不明である。 なので、「a.」と打鍵しても、インテリセンスの候補は挙がってこない。 XMLドキュメントコメントの盲点さてこのように、Visual Studio 上で JavaScript コードを編集するにあたり、自分が作成する関数にも記述することで大変便利になる XML ドキュメントコメントである。だが、ひとつ、難点がある。 <summary> ~ </summary> などの定型部分も、すべて自分でタイプして書かねばならないため、大変面倒 なのだ。 せっかくの Visual Studio の超強力支援機能を、自分が書いたコードにも活かすためなのに、これでは本末転倒になりかねない。 しかし。 ここで救世主が現れる。 それが JScript vsdoc Stub Generator というアドイン、 Visual Studio に対する拡張機能だ。 JScript vsdoc Stub Generatorこのアドインを入れておくとどうなるか。関数定義の直後でスラッシュを3回打鍵すると... XMLドキュメントコメントのひな形をその場で生成してくれるのだ! たくさんのスラッシュと XML タグとを一字ずつ打つのとでは雲泥の生産性だ。 こんなにありがたいアドインをインストールしておかない手はない。 作者である Michael Obermeyer 氏に感謝である。 ちなみに、無償版である Visual Studio Express 版では、無償版としての性格上だろう、アドインのインストールができないという制限がかけられているので、残念ながらこのアドインは利用できない。 同じ Visual Studio でも、有償版である Professional 版からのみ、アドインの利用が可能なのであしからず。 JScript vsdoc Stub Generator http://goo.gl/pDKX0
by developer-adjust
| 2012-12-06 08:11
| Visual Studio
|
Comments(0)
|
ファン申請 |
||