BT

Microsoft、.NETドキュメントの統合を発表

| 作者: Michael Stiefel フォローする 5 人のフォロワー , 翻訳者 sasai フォローする 0 人のフォロワー 投稿日 2017年5月11日. 推定読書時間: 2 分 |

原文(投稿日:2017/04/28)へのリンク

Microsoftが新しい.NET APIブラウザ発表した。このブラウザから、あらゆる.NET関連ドキュメントが見つかるようになるだろう。最初のリリースには、.NET Framework、.NET Core、.NET Standard、Xamarin、Azure NuGetパッケージのリファレンスが含まれている。今後はユーザーのフィードバックに基づいて追加される予定だ。

これで一つの場所から標準化された方法で、.NET互換SDKドキュメントを検索、表示、発見、ナビゲートできるようになる。関連ドキュメントと適切なパッケージのダウンロード場所を見つけるのに検索エンジンを使わなくて済むため、開発者の生産性は向上するだろう。

APIブラウザにネームスペース、クラス、メソッドの名前を全部もしくは一部入力することで、直接検索できるようになる。これはIntelliSenseと同じように動作する。キーワードを入力すると、可能性のある項目がリストアップされ、その中から選択すればよい。クイックフィルタを選んで検索範囲を狭めることもできるし、API全体から検索することもできる。フィルタを使って、C#、VB、C++によるサンプル付きのドキュメントを読むこともできる。検索対象の.NETのバージョンを指定するためのフィルタもある。型が特定のバージョンに含まれているか、もう心配する必要はない。ブラウザ上部にはAPIの目次があり、必要に応じてドキュメントを読むことができる。PDFのダウンロードも利用可能だ。

ドキュメント自体も、最も重要な情報が最初に表示されて読みやすくなった。詳細なドキュメントの前に、概要とプログラム例(言語によってフィルタされる)が表示される。ネームスペース、型、メンバーのいずれかをブラウズすると、ブラウザの左サイドの目次にその子項目が表示される。これで、自分の見ているコンテンツがわかるだろう。

また、継続的インテグレーションツールによって、リリースして数時間以内に正確なドキュメントを手に入れることができる。管理されたリファレンスは、NuGetフレームワークのディストリビューションから自動生成される。ドキュメントの生成にはDocFXmdocなどのオープンツールが使われている。

ドキュメントに対するコミュニティからのコントリビューションも可能になる。ドキュメントにはECMAXML形式が使われており、すべてのSDKが一貫性のある書式を持つようになる。コンテンツはMarkdownを使ってコントリビューションすることができ、自動生成されたドキュメントに埋め込まれる。ドキュメントのファイル形式について、あなたは何も知る必要はない。

ユーザーはUser Voiceサイトから、改善のリクエストと、どの提案がもっとも重要かの投票ができる。これにどのドキュメントをAPIブラウザに追加してほしいかも含まれる。アップデートについては、Twitterアカウント@docsmsftを参照しよう。

Rate this Article

Relevance
Style

この記事に星をつける

おすすめ度
スタイル

こんにちは

コメントするには InfoQアカウントの登録 または が必要です。InfoQ に登録するとさまざまなことができます。

アカウント登録をしてInfoQをお楽しみください。

あなたの意見をお聞かせください。

HTML: a,b,br,blockquote,i,li,pre,u,ul,p

このスレッドのメッセージについてEmailでリプライする
コミュニティコメント

HTML: a,b,br,blockquote,i,li,pre,u,ul,p

このスレッドのメッセージについてEmailでリプライする

HTML: a,b,br,blockquote,i,li,pre,u,ul,p

このスレッドのメッセージについてEmailでリプライする

ディスカッション

InfoQにログインし新機能を利用する


パスワードを忘れた方はこちらへ

Follow

お気に入りのトピックや著者をフォローする

業界やサイト内で一番重要な見出しを閲覧する

Like

より多いシグナル、より少ないノイズ

お気に入りのトピックと著者を選択して自分のフィードを作る

Notifications

最新情報をすぐ手に入れるようにしよう

通知設定をして、お気に入りコンテンツを見逃さないようにしよう!

BT