問題タブ [scaladoc]
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.
scala - scaladoc で /* をエスケープするには?
Java サーブレット構成の例を含むコメントがあります。次のようになります。
コメント内の/*
は、Scala でネストされたブロック コメントを作成し、それが scaladoc ツールを混乱させるようです。/*
ブロックコメントでエスケープする方法はありますか? または、そのテキストを表示する別の方法はありますか?
誰かがエンティティ / の使用を提案しました。ただし、エンティティは {{{ }}} コード ブロック内では機能しません。
sbt - scaladoc が使用できるリソース (画像など) をどこに配置するか?
私は現在、Scala で書かれた API のドキュメントを書いています。コードをより理解しやすくするために、いくつかの図を含めたいと思います。
リソース (ダイアグラムなど) を scaladoc の呼び出しによって自動的にインポートできるようにするには、どこにリソースを配置すればよいか、コードのドキュメントでこれらのリソースを参照する方法を考えています。
たとえば、sbt を使用しているとします。私のコードはsrc/main/scala
ディレクトリにあります。package の scala パッケージ オブジェクトの例を次に示しますfoo
。
scaladoc から見えるようにするには、'diagram-foo.svg' をプロジェクトのどこに置くべきですか? 続いて、タグpath/to/
内の正しい値は?img
sbt - scaladoc に追加のソース ディレクトリを指定する方法は?
Eclipse と sbt の両方を使用する必要があるため、少し非標準の sbt ビルド セットアップがあります。
私のソースはsrc/main/scala
とsrc/com/companyname/[folder1, folder2, etc]
ディレクトリにあります。
sbt をセットアップして、これらの追加folderX
フォルダーのドキュメントも生成するようにするにはどうすればよいsrc/com/companyname
ですか?
scala - パターン定義で val を文書化する方法
クラスのすべての val と def に ScalaDoc エントリを作成したいと考えています。/** */
問題は、val がパターン定義内にあり、構文の使用方法がわからないことです。
例:
part1とpart2を文書化するにはどうすればよいですか?
ScalaDoc についてこのドキュメントを尋ねる前に読んだことがあります。
playframework - Play プロジェクトで 'dist' を実行するときに scaladoc をスキップする
Play プロジェクト (現在 Play 2.3.0 を使用) で 'dist' を実行するときに scaladoc の実行を停止するにはどうすればよいですか? 例として:
そのプロセスの「scaladoc」部分には、20 秒のうち約12秒かかります。scaladocをまったく実行したくありません(この非ライブラリ プロジェクトで作業を行っている人は、実際のソース コードを見ることになります)。