フレームワークやプログラム言語の仕様を高速で確認できる便利ツール『Dash』。
私はどちらかというとこのツールのスニペット機能をメインで使っていて、プログラムやツールに関するトラブル解決は主にネットの情報を利用していました。
これは、「公式ドキュメント」から逃げたい意識があったと思います。
身近な人には「公式ドキュメントを見ればわかる」のようなことを言っているのですが、自分は「どこかにもっと楽に解決している人がいるはず」と、公式ドキュメントは後回しにしていたのです。これは、一概に悪い方法では無く、実際に対象によっては個人ブログのほうがわかりやすいことも多いです。

しかし最近、最終的に公式ドキュメントを読むことでトラブルが解決した事が続き、意識して『Dash』でドキュメントを参照する癖をつけようとしています。

『Dash』のドキュメントで表示されるアイコンの正式な一覧が知りたい

Dashを使い始めて数年来、疑問に思っていたのがアイコンです。

なにかを検索、例えば「transform」を参照しようとしたときにズラッと並ぶアイコンです。

それぞれ言語毎にフォーマットの異なるドキュメントですが、見出しあたりの記載からも予測はできます。

もちろん、アイコンだけでもCならクラス、Pならプロパティ、Mならメソッド、Fならファンクションだろう、と予想は付きます。
ただ、Dashのヘルプなどで確認の為、対応表的なものを確認したかったのですが、見つけられませんでした。
「多分、世の中のプログラマーの人たちにとっては確認するまでも無い、常識的な感じなのだろう・・・」
と、アイコンの件は忘れていました。

とはいえ

「Hook」用のアイコンもあったりして、皆「H」で「ああHookね」とか分かるんか？とほぼ一人で仕事をしている私は不安になっていました。
後、「P」でも色違いで多数あったりして、これはPDFアイコンやAIアイコンなみに常識的なやつなのか？Dash独自のやつなのか？と悩みつつも、Dashをドキュメント検索で使う頻度が低い（ほぼスニペット機能を利用）こともあり、この件は忘れていました。

あった

アイコン対応表ありました。

https://kapeli.com/docsets#supportedentrytypes

Dash用のドキュメントの作成方法のページにありました。
「ドキュメント作成の際は、これらのアイコンが自由に使えますよ」
ということなので、公式ヘルプ等での厳密な定義は無かったのかもしれません。
長年のもやもやが晴れて、「おい『G』、おまえ『Guide』やったんか！」的な感じで見入ってしまいました。

もしかすると自分と同じような人もいるかもしれないので共有しておきます。

補足-経緯「C#だけ」のドキュメントが欲しい

最近Unityを使っているので、C#のヘルプか公式ドキュメントを入れておきたいのですが、ありません。
Dashは本当にCでもSWIFTでもDockerでもSASSでも、多くのプログラム、ツール、フレームワークのドキュメントが用意されています。
でも「C#」は無いのです。
分かります。きちんとした開発者の人に言われることはだいたい分かります。

「.NET FrameWork」「Mono」「Xamarin」が用意されているでしょう。

実際、過去の公式Twitterを参照しても、C#に関しては上記の意見が目に付きました。

ただ、Unity(2019以降)の場合色々な経緯もあり、MonoのようなFramework準拠では無く、シンプルな「C#」のドキュメントがあれば、という要望が私にはありました。

無さそうなので、「誰か作って無いかな」とサードパーティのサイトを検索していた所、アイコン一覧に行き当たり、しばりC#のことは忘れて喜んだ次第です。

C#ドキュメントについて補足

「Stackover Flow」のスレッドをダウンロードした場合、C#に関する記述にヒットさせる事は可能です。

私の場合は
・Onlineの場合、タイムラグがあり、Dashの高速性のメリットが失われる
・Offlineでダウンロードした場合、2GBもある。※通常のプログラムのドキュメントは50〜数百MB。
・未解決のイシューにヒットしまくる
為、外しました。

高速なドキュメント参照ツール『Dash』の検索対象を絞ってみよう！
のように、Stackover Flowでの結果に絞ったサーチプロファイルを設定する場合は有効に使えるかもしれません。

もしC#単体のドキュメントに関する情報があれば教えて下さい！

投稿 高速ドキュメント検索ツール『Dash』で表示されるアイコン一覧 は studioDoghands に最初に表示されました。

プログラム言語やIDE、その他アプリなどの仕様やヘルプドキュメントをローカルで高速に検索できる便利ソフト『Dash』。
スニペットツールとしても有名です。
今回はこの『Dash』のドキュメント検索をちょっと便利にしてみましょう。

Dash公式サイト

Dashの検索ドキュメント対象を絞ってみよう

プログラムのドキュメントの場合、複数の言語で似たようなクラスやメソッドがたくさんあります。
しかし、例えばWordPressサイトを作成している時に検索の対象にしたいのは、PHPやWordPressの仕様、後は場合によりjavascript、jQery、SASS、Bootstrapのドキュメントだけだと思います。
今回は、検索窓に特定のキーワード（例えばw:）を入力した場合、あらかじめセットしたドキュメントのみが検索対象になるように設定してみます。

設定してみる

この、検索対象の設定は「Search Profiles」と呼ばれます。
詳細はhttps://kapeli.com/dash_guide#searchProfilesを確認してください。

はじめに、設定作業中はDashのPreferences→Generalから、「Dismiss main window when I activate different app」のチェックを外しておいたほうが良いかもしれません。
これにチェックが入っていると、DashのWindowが選択状態から外れるとすぐに閉じるため、（普段使いには便利ですが）Dash自体の設定のときは開き直すのが面倒だからです。

まず、Dash起動後にサーチボックスの虫眼鏡アイコンをクリックします。

サーチプロファイルの追加

プロファイルを追加します。下の＋ボタンをクリックします。

プロファイルの名前をつけます。「Web制作」や「WordPress」のような感じで良いでしょう。今回は「WordPress」で設定してみます。

ちなみにアイコンの設定も可能です。

キーワードの設定

「Activate this profile when:」の＋ボタンをクリックします。

「Search Keyword」を選択します。
ショートカットキーや特定のアプリを起動している場合、ナビゲーターの挙動による検索対象の変更も可能です。

キーワードは「w」としておきます。これで検索ボックスに「w:」と入力した場合、下でで設定するドキュメントセットが検索対象となります。

サーチ対処のドキュメントを選択

検索対象のドキュメントを選びます。
「Search these docsets:」の＋ボタンをクリックします。

こんな感じに選んでみます。

自作スニペットを検索対象に含めるかどうかのチェックボックスです。

使ってみる

Dashを起動、サーチボックスに「w:」を入力すると、「WordPress」サーチプロファイルに切り替わり、検索対象が先程選んだドキュメントのみになります！

通常状態（全てのドキュメントが検索対象）に戻すのが面倒なので、デフォルトにも「d:」のような感じでキーワードを設定しておきます。

他にも設定してみる

Unityにも設定してみました。

私の場合、WEB制作作業中は、ついドキュメント検索よりも身近なWEB検索に頼ってしまい（もちろん有用な場合も多いですが）、回り道になることがあります。

「公式ドキュメント見たくない」の一心で色々とネットを回った結果、公式のサンプルコードが一番分かりやすかった、ということは非常に多いです。

公式ドキュメントを参照することに慣れる為にも、意識的にDashを使ってみたいと思います。

投稿 高速なドキュメント参照ツール『Dash』の検索対象を絞ってみよう！ は studioDoghands に最初に表示されました。