問題タブ [documentation]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
12 に答える
39629 参照

java - JavaDoc の読み方

JavaDocs を読むためにどのツールや Web サイトを使用していますか?

私は現在、J2EE プロジェクトに取り組んでいるときに 20 個以上のタブを開いた状態で Firefox を使用しています。

このようなツール/ウェブサイトに期待すること:

  • さまざまな場所から JavaDoc を集約する
  • Eclipse の Ctrl+T などのタイプへの直接アクセス
  • 全文検索
  • 選択したすべての Java ライブラリ間の相互参照
  • ツールの場合: オフライン サポート
  • スピード

必須ではありません:

  • 物事に注釈を付ける可能性
  • ライブラリの異なるバージョンのサポート (+ diffing ?)
  • IDE 統合

編集:

回答ありがとうございます。ほとんどのサイトは知っていましたが、もう一度試してみました。ここに私の判断があります:

  • 組み込みの Eclipse/IDE 機能
    • 緊密に統合された
    • オフライン/オンライン サポート
  • javadoconline.com (もはや維持されていません)
    • 作品
    • きれいなルックス
    • API の複数のバージョンで一致を検出し、簡単に切り替えることができます
    • シンプルだが機能する
    • 速い
  • jdocs (オフライン)
    • とても洗練されているようです
    • 時々遅い
    • 一部の最近のバージョンのライブラリが見つからないようです (Seam 2.0.0、Hibernate Validators) が、自分で追加できるようです。
    • IDE 統合 (未テスト)
    • 各項目への wiki 形式のコメント
  • docjar.com
    • 作品
    • 速い
    • 雑然とした UI
  • javadoc_isearch
    • javadoc のナビゲートを容易にする firefox 用のグリースモンキー スクリプト
    • スムーズかつ完璧に動作します
0 投票する
2 に答える
2278 参照

sql-server - SQL Server 2008ReportingServicesレポート定義のカスタマイズ拡張機能

最近、SQL2K8のレポート定義カスタマイズ拡張機能(RDCE)を調べていましたが、インターネット上で多くのドキュメントやおしゃべりを見つけることができませんでした。

MSDNには簡単な概要があります:http://msdn.microsoft.com/en-us/library/cc281022.aspx

そして、この本のサンプルレポートhttp://www.amazon.com/Applied-Microsoft-Server-Reporting-Services/dp/0976635313/ref=pd_bbs_sr_2?ie=UTF8&s=books&qid=1221629676&sr=8-2は何かですが、誰かがこれを実際に経験したかどうか、そしてそれが彼らのためにどのようにうまくいったか疑問に思いました。そして、誰かが見る価値のある他の参考文献を持っているなら、私はそれをいただければ幸いです。

0 投票する
1 に答える
881 参照

java - Spring Web Flow のスナップショットとフロー リポジトリに関する最適なドキュメントは何ですか?

Spring Web Flow でのスナップショット、フロー リポジトリ、およびフロー状態のシリアライゼーションに関するより多くの優れたドキュメントを探しています。私が見つけた利用可能なドキュメントはかなりまばらに見えます。「Spring in Action」はこれについて語っていません。Spring Web Flow リファレンス マニュアルでは、ここでいくつかのフラグについて言及しています。

http://static.springframework.org/spring-webflow/docs/2.0.x/reference/htmlsingle/spring-webflow-reference.html#tuning-flow-execution-repository

しかし、これらの設定や使用パターンなどを変更する理由については実際には話していません.

誰でも良いリファレンスを持っていますか?

0 投票する
8 に答える
7214 参照

documentation - ソフトウェア ドキュメントを保存する最良の方法は何ですか?

明白な答えは「内部ウィキ」です。ソフトウェアのドキュメントに使用される wiki の長所と短所は何ですか? 他の提案はありますか?ソフトウェアのドキュメントには何を使用していますか?

Loren Segal - 残念ながら、ソース コードのコメントから情報をコンパイルするドキュメント ツールはサポートされていませんが、技術ドキュメントを保存する最良の方法であることに同意します。私の質問は、sysadmin タイプからユーザー ドキュメントまで、あらゆる種類のドキュメントに関するものでした。

0 投票する
9 に答える
9859 参照

php - PHPDocよりも優れたものはありますか?

PHP同じドキュメント構文を読み取るが、より豊富な出力を提供するツールはありますかPHPDoc?

0 投票する
3 に答える
6327 参照

documentation - 優れた MAML エディターを知っている人はいますか

職場では、ヘルプ ファイルの作成に Sandcastle を使用しています。しばらくの間 S​​andCastleGUI を使用しており、ヘルプ ファイルに追加のページを作成する方法を探しています。これらのページは、MAML と呼ばれる XML 形式で記述されています。唯一の問題は、これらのファイル形式に適したエディターが見つからなかったことです。

追加のドキュメント ページを作成および編集するための WYSIWYG エディタを探しています。

0 投票する
2 に答える
10458 参照

actionscript-3 - ActionScript 3.0 で FlashVar を使用するにはどうすればよいですか?

Flash CS3 にはこれらのパラメーターを読み取るための使用例がないため、ここに投稿すると役立つかもしれないと考えて、フラッシュ パラメーターを使用するためのこのガイドを見つけました。

リンクの回答を見る

0 投票する
3 に答える
1372 参照

vb.net - Visual Studio 2008、VB.NET Express Edition の「情報が見つかりません」ページ

VS 2008 Express エディションを試していますが、キーワードまたはクラス名で f1 を押すと、90% 以上の確率で [情報が見つかりません] ページが表示されるようです。

これは構成上の問題ですか? これは「ビールのように無料」のエクスプレス版だからですか?Microsoft は、私がダウンロードしたバージョンからオンライン ドキュメントを移動しましたか?

私は、これが彼らの主力開発製品のデモであり、ほとんどすべての種類の統合された参照ドキュメントが欠けているように見えることにちょっと驚いています. Visual Studio の統合ヘルプはどのように機能しますか?

0 投票する
6 に答える
390 参照

build-process - 自動ビルドでドキュメントを生成する

自動ビルド中にプロジェクトドキュメントを生成する方法はありますか?

ユーザーマニュアルを含む単一のソースファイル(HTML?)のセットが欲しいのですが、それらから以下を生成します。

  • PDFドキュメント
  • CHMヘルプ
  • ヘルプのHTMLバージョン

内容は基本的に3つのフォーマットすべてで同じです。

現在、msbuildとCCNETを使用していますが、必要に応じて変更できます。

0 投票する
3 に答える
359 参照

installation - ソフトウェアのサーバー側インストールに関するドキュメントのテンプレートはどこにありますか?

私が取り組んでいるプロジェクトのソフトウェアのサーバー側インストールに関する適切なテンプレートを探しています。

クライアント側は非常に簡単です。サーバー側のインストールは少し複雑です。これはいくつかの要素 (サービス、データベース接続、依存関係、ブロック解除が必要なポートなど) で構成されています。最近のテスト中に、いくつかの文書化されていない断片が発見されました。ここで、災害復旧計画のためのインストール ドキュメントを作成し、必ずしも「完全な」システムをテストすることなくインストールをテストする方法を作成する必要があります。

テンプレートまたはそのようなドキュメントの本当に良い例をどこで入手できるかについての提案が本当に欲しいです. オペレーターが回復の最中に読んで理解できるものにしたいと思います.


[編集] 現在のドキュメントは、主に管理者がオフサイト テスト中に持っていた質問に基づいています。新しいコードが書かれているので、ドキュメントが事前に書かれていることを確認したいと思います。テストを開始するために VMWare イメージを収集してきましたが、いくつかの良い例を探していました。Windows Server ショップ (2000 & 2003) です。Word のテンプレートもいいですが、良いドキュメントがあれば、テンプレートを作成できます。何をテストすべきかについての提案も素晴らしいでしょう。


[2回目の編集]投稿された回答からいくつかの良いアイデアを得ました。Google 検索を変更した後、いくつかの良い出発点を思いつきました。それらは完璧ではありませんが、良いスタートです。

Microsoft Exchange - http://technet.microsoft.com/en-us/library/bb125074(EXCHG.65).aspx iPhone - http://manuals.info.apple.com/en_US/Enterprise_Deployment_Guide.pdf

http://www.novell.com/documentation/gwgateways/gw7_exch/index.html?page=/documentation/gwgateways/gw7_exch/data/ab32nt1.html http://cregan.wordpress.com/2006/06/22/ exchange-2003-step-by-step-install-instructions/

http://technet.microsoft.com/en-us/magazine/cc160942.aspx

設計段階の計画を十分にカバー - http://www.onlamp.com/pub/a/onlamp/2004/04/08/disaster_recovery.html?page=2


[2008 年 10 月 29 日編集]
これは私が探していたタイプのサンプルです。ゴミはあまりありませんが、その理由と方法を十分に説明しているようですhttp://wiki.alfresco.com/wiki/Installing_Labs_3_Nile