タグ

関連タグで絞り込む (0)

  • 関連タグはありません

タグの絞り込みを解除

C#とdocumentationに関するkenjiro_nのブックマーク (3)

  • C# Visual Studio 2012 Professional で SHFB (Sandcastle Help File Builder) を使う | HTML5 CSS3 JavaScript – WEBYA.IN

    C# Visual Studio 2012 Professional で SHFB (Sandcastle Help File Builder) を使う Java でいう Javadoc 的な、C# 版の javadoc、いわゆる「ライブラリとしてのドキュメントを生成」ができるツールがないかと探していたら、Sandcastle Help File Buider というものを見つけた。 いろいろ調べてたんだけどちょっち古いのが多く、新しい環境ではなかなか動かすところまで行き着けなかったので、確実に実現するところまでを記すよ。(2013.01.08 時点) 尚、この手順は Visual Studio 2012 Professional がインストールされている前提で進めます。 ダウンロード 右部のサイドバー、紫の「download」ボタンでダウンロードが始まります CodePlex – Sna

  • C#でJavaDoc風のAPIリファレンスを作成する方法 - redwarrior’s diary

    C#でも、Javaで言うところのJavaDocみたいなコメントの書き方があります。 ドキュメントコメントと呼ばれていて、///で始まり、paramタグとかreturnsタグとかを書くことが出来ます。 このドキュメントコメントから、APIリファレンスを作成する方法を調べたので書いておくことにします。 今回、APIリファレンスを作成する対象は、Spracheというパーサージェネレーターです。 これはチュートリアルがあって結構わかりやすく書いてあるのですが、APIリファレンスが無いので使用する時に何を使えばいいのか困ります。 ソースを確認したところ、ドキュメントコメントは書いてあったので、APIリファレンスを作成して、ついでに手順をブログにまとめておこうという算段です。 まず、いつもの通りに先人の知恵を借りるということで、以下の2サイトを参考にさせてもらいました。 d.hatena.ne.jp

    C#でJavaDoc風のAPIリファレンスを作成する方法 - redwarrior’s diary
  • C# VB.Net におけるソースコードのドキュメント化(Sandcastle) - Qiita

    C#/VB.Netで開発をしていて、JavaDocいいな・・・なんてさみしい思いをしたことはないでしょうか。 実は、Sandcastleというツールを使用することで.NETでもソースコードからドキュメントを生成できます(こんな感じ)。今回はその方法をご紹介します。 Sandcastleのインストール Sandcastleはもともとマイクロソフトが開発していたのですが、2010年ごろおやめになってしまい(ええっ!?)、それからしばらく.NETではJavaDocのようなツールがない状態でした。 その後(2012~2013年ごろ?) Eric Woodruffという心優しい方が元プロジェクトをforkし新たにSandcastle Help File Builderとして開発を行ってくださり、今に至ります。 前書きはこれくらいにして、ありがたくインストーラーを頂戴します。 https://gith

    C# VB.Net におけるソースコードのドキュメント化(Sandcastle) - Qiita
  • 1