Sandcastle Help File BuilderでVisual Studioからヘルプファイルを作成する方法 【▲→川俣晶の縁側→ソフトウェア→技術雑記】
手順1 § githubからSandcastle Help File Builderの最新版をダウンロードしてインストールする。その際、インストーラーのNextを押していくだけではダメで、インストールする項目は明示的にインストールを選ぶ。 インストールが終わったらマシンを再起動。 手順2 § Visual Studio 2015を開き、プロジェクトの新規作成を選ぶ。 ここで、【インストール済み→テンプレート】の下の【Document】を選ぶ。けして、【インストール済み→テンプレート→Visual C#等】の下の【Document】を選んではいけない。(道に迷う) そこで、”Sandcastle Help File Builder Project”を選んで新規作成する。 手順3 § ソリューションエクスプローラにある"Documentation Sources"ノードを右クリックして、”Ad
Sandcastle Help File Builderのビルドを高速化する - アジョブジ星通信
本当に遅いです、うんざりするほど遅いです。で、今日もまたSHFBいじってたらいい感じに高速化してくれる方法を見つけたので紹介します。 ProjectPropertyのComponentConfigurationsを開いて、頭にCachedが付くのを全部Addするだけ。終わり。 これで次の次のビルドからそれなりに速くなります。僕の環境だと6分以上かかったのが2分程度になりました。でももうちょい速くなって欲しい…。
Sanscastleでライブラリのドキュメントじゃないヘルプファイルを作る - Qiita
Sandcastle Help File Builder の Visual Studio 拡張を使ってヘルプファイルを作るメモ。 準備 最新の Sandcastle Help File Builder をインストールします。 .NET 4.5 を使っている場合は、Sandcastleの「MRefBuilder」をソースコードからビルドし直すことをおすすめします。 プロジェクト作成 今回は Visual Studio からプロジェクトを作成してみました。 アカデミック版買ってよかった。 作成したら、もちろん空のソリューションが出来上がります。 wktkしますね！！！！！ プロジェクト設定 プロジェクトを設定していきます。 まず、HelpFileタブで、タイトル・見た目などを設定します。 Englishになってるって？はい、日本語入れてないので…。ググれば結構落ちてます。 次に、大事なポイント
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
SandCastleの日本語ヘルプパックを公開した - tuedaの日記
どうもSandCastleの日本語情報が少ない｡あるけど古い｡日本語翻訳ファイルを作っている人を何人か見つけたが 自分が使う範囲しか翻訳してなかったりどうも使いにくい｡ というわけで最新のSHFB 1.9.6をベースに全部のスタイル(hana,Prototype,vs2005,vs2010)の翻訳ファイルを作って公開した｡ いい仕事したぜ｡ .Netでドキュメント作るのにSandCastleいるだろ､英語と日本語のチャンポンで出力したら読みにくいだろ､ 誰か翻訳ファイルを作って公開しろよ､お前がやれよ､いいよやってやるよ､どうぞどうぞ､公開したぞ(ﾄﾞﾔｯ (←今ここ) あとヘルプファイルにAPIリファレンスだけでなく任意のページ(例えばチュートリアルとか)を挿入するのは結構難しい｡ できなくはないけど､MSのヘルプ形式で長い文章を読ませるのはどうがんばっても無理｡労力にあった成果にはなら
ドキュメントコメントの「code」タグを使うとタイトルが「C#」になる - misc.log
Visual Studio 2010などにある、定型書式のコメントからヘルプを作る機能で、サンプルコードを埋め込むタグ「code」を使うと、なぜかサンプルコード部分のタイトルが「C#」になってしまうという問題がずっと出ていました（下図参照）。 まぁサンプル自体は読めるのでいいと言えばいいのですが、なんせ格好が悪い。というわけでちょっと探したら、SandCastleがタグを拡張して言語とかを指定できるようにしているようです。たとえば、Codeタグは <code lang="vbnet">のようにすればSandCastleで処理するときに解釈してVisual Basicというタイトルにしてくれるみたい。他にもXMLなどいろんなサンプルタイトルが用意されているようなので、以下のリンクを参考にしてみてください。 参考 stackovervlow/How to specify language in
SandCastleでのヘルプファイル生成をTFSのビルドプロセスに組み込む際の留意点 - Yasuo's Notebook
今日、少しはまったので備忘録として。 SandCastleというツール。ソースコードに書かれたコメントから ヘルプファイルを生成するツールで、API仕様を出力したり、テストコードにテスト仕様をコメントで書いてテスト仕様を出力するのに活用しています。 http://sandcastle.codeplex.com/ このツールを使ったヘルプ生成をTFSのビルドプロセスに組み込む際に、注意点があります。 ビルドプロセスへの組み込み方法は、TFSのビルドプロセスにOpenCoverのカバレッジ計測を組み込む（後半） - Yasuo's Notebookと同じです。バッチファイルを実行する処理とビルド結果のディレクトリへの生成ファイルのコピーを追加します。 サーバー上でバッチファイルを実行してうまくヘルプファイルを生成できることを確認してTFSでのビルドを実行しても、うまくヘルプが生成されません。
Sandcastle Help File Builder1.9を使ってヘルプを生成する - あおきのTechメモ
2013年追記 2013年のSandcastle Help File Builderバージョン1.9.6/1.9.7時点では、下記サイトの情報が最新となっています。 Sandcastle(XMLコメントからAPIヘルプ生成) C#やVB.NETでヘルプファイルを作成する手順メモです。Sandcastleが以前と少し変わったため、以下にまとめときます。 インストールするもの Sandcastle XMLコメントを解析をする本体 Sandcastle 日本語メッセージ APIドキュメントを日本語化したい場合に上書きコピー Sandcastle Help File Builder ヘルプ生成が簡単なGUIツール HTML Help Workshop HTML Help 1.x形式を出力する場合 すでにインストールさせていれば不要。HTML Help1.x形式を指定してエラーが出た場合に導入する
【ハウツー】SandcastleでXMLドキュメントコメントからヘルプを生成する - HTML生成編 (1) XMLドキュメントコメントの書き方 | エンタープライズ | マイコミジャーナル
ヘルプドキュメントの作成 チームで開発をしている時に、共通部品のドキュメントがあれば良いのにと思ったことはありませんか。また、MSDNのようなAPIリファレンスを作成しなければいけない状況になったことはありませんか。 このような時にWordやExcelを使ってヘルプドキュメントを書くとなると、プログラムとの整合性を保つ必要があり多くの工数がかかります。そこで本稿では、ソースコードに記述したクラスやメンバの説明から、リファレンス形式のヘルプドキュメントを生成できる「Sandcastle(サンドキャッスル)」というツールについて紹介します。 構成について 本稿では、Sandcastleというソフトウェアを使って、.NETのソースコードに記述したコメントからヘルプファイルを生成する方法について紹介します。この前編では、以下の内容について紹介します。 ・Sandcastleの概要とXMLドキュメン
Sandcastle Help File Builder 1.8.0.3 が出ています
やまだの仮想庭園 ～ いつか実体の伴う日まで 目次 ホーム 連絡をする RSS Login Blog 利用状況 投稿数 - 105 記事 - 1 コメント - 432 トラックバック - 37 記事カテゴリ 雑記 書庫 2012年7月 (1) 2012年6月 (1) 2012年5月 (1) 2012年4月 (1) 2012年3月 (1) 2012年2月 (1) 2012年1月 (1) 2011年12月 (1) 2011年11月 (1) 2011年10月 (1) 2011年9月 (1) 2011年8月 (1) 2011年7月 (1) 2011年6月 (1) 2011年5月 (1) 2011年4月 (1) 2011年3月 (1) 2011年2月 (1) 2011年1月 (1) 2010年12月 (1) 2010年11月 (1) 2010年10月 (1) 2010年9月 (1) 2010年8月
Sandcastle Help File Builder を使って、ソースコードからドキュメントを自動作成しよう
Sandcastle というのは、ソースコードの構造やコメントを元に、ドキュメント(APIや内部説明書)を自動作成してくれるソフトです。 類似のソフトとして、doxygenやNDocがあります。 今回は、Sandcastle と 支援ソフトの Sandcastle Help File Builder の使い方について、簡単に説明します。 まずは概要 Sandcastleには、以下の特徴があります。 MSDN風のHTML Help形式(.chm)のドキュメントを作成してくれます。 .NET 2.0に対応しています。 Microsoft自身が対応してくれています。 VS SDK 4.0 December CTP に同梱されたり、単独で配布しています。 日本語を使っても大丈夫のようです。 Sandcastleについて、先行で調べてらっしゃる方については、以下が参考になると思います。 Kazzzの
Sandcastleを使ってみた
最近はARToolkitPlusとC#, WPFの組み合わせで遊んでいます。 他に扱う内容は、自身の健康状態の記録と、後述の「身も蓋もない」開発で学ぶ事になった.Net Framework, C#, WPFなどの話題や、「身も蓋もない」開発の副産物であるスキップリストを.Net Framework上で実装したライブラリなどについての技術的な話題です。スキップリストのライブラリはメソッドのオーバーライドにより任意の区間に渡っての可換半群の総和計算を高速に行える汎用性の高さを持っています。 また、クリック証券のトレードツール はっちゅう君プラス 用の アドイン 「身も蓋もない」 の開発記録が残されています。「身も蓋もない」は合理的なティック・四本値の可視化と極限まで単純化された注文機能でデイの裁量トレードを強力に支援します。 SandCastleを使ってみて、自分なりのまとめ。Html Hel
こんなん出た～
片桐 継 は こんなやつ かたぎり つぐ ってよむの 大阪生まれ河内育ちなんだけど 関東に住みついちゃったの 和装着付師だったりするの エセモノカキやってたりするの VBが得意だったりするの SQL文が大好きだったりするの 囲碁修行中だったりするの ボトゲ好きだったりするの F#かわいいよF# 正体は会った人だけ知ってるの 空気読まなくてごめんなさいなの わんくまリンク C# VB.NET掲示板 わんくま同盟Blog WindowsでGo言語 ネット活動 SNSは疲れました やままださんちでも話題になってた帰ってきたSandCastleにちょい絡み？ そういや、ウルトラマンジャックって後付の名前で、TV放送リアルタイムは名無しさんだったんだよなぁ。メビウスで「ジャック兄さん」と聞いたときには正直感慨深かった（違っ） てなわけで、こんなん見つけました～ Sandcastle Assist h
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Gunnar Peipman's ASP.NET blog - Using Sandcastle to build code contracts documentation
Blog - Mikula Beutl - SEO Consulting
Blog - Mikula Beutl - SEO Consulting
SandCastleでAPIリファレンスを作るテスト - tuedaの日記
SandCastle VisualStudioプラグイン - tuedaの日記
Sandcastle Help File Builder 1.6.0.4 がリリースされます。