問題タブ [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のObjectクラスでvalの名前を参照するには?
次のように、scaladoc を使用して Object クラスの val の名前を参照する方法はありますか
javadoc で。
eclipse - Eclipse Scala プラグインが scala プロジェクトのクラスとメソッドのドキュメントを表示しない
eclipse (Mars) を使用して scala プラグインをインストールしましたが、ドキュメントに関して問題が発生しました。新しい Java プロジェクトを作成してコードを書くとき、いつものようにクラスとそのメソッドにカーソルを合わせると、ドキュメントが表示されます。
ただし、新しい Scalaproject を作成すると機能しません。例えば:
String または charAt にカーソルを合わせると、
表示される小さなボックスに。Java クラスとそのメソッドにドキュメントがないだけでなく、Scala メソッドとクラスにも注意してください。
Scala IDEから直接ダウンロードできるScala IDEを使用するだけでなく、セットアップ全体を再インストールしようとしました
これには他にも問題がありましたが、それらはすべて 1 年かそれ以前のもので、その間にバグがありました。ただし、このバグはかなり前に修正されています。
機能するのは、メソッドとクラスの上に自作のスカラドックですが、それだけです。
誰でもこれを修正するのを手伝ってもらえますか? Javadoc パスも rt.jar に設定されているので、本当にアイデアがありません。
ありがとう!
更新 次のことを試しました:
「適用」などのいくつかのメソッドのドキュメントを取得しました。ただし、次のように文字列にカーソルを合わせると、まだドキュメントが表示されません: Scala IDE 紹介ビデオ
私が得るものは
あまり役に立たない...
scala - Scaladoc (2.11.6) が「リンクするメンバーが見つかりません」というスロー タグで失敗する
sbt "++2.11.6 publishLocal"
またはを介してプロジェクトの jar を公開しようとすると、sbt +publishLocal
Scala 2.11.6 の公開時に Scaladoc の問題が発生します。@throws
タグが原因で無効なリンクが表示されているようです。無効なリンクがある理由や、クロス パブリッシュ中に Scala 2.10.5 ではなく Scala 2.11.6 でのみエラーが発生する理由がわかりません。@throws
このタグが Scala 2.11 でサポートされていないという兆候は見つかりません。私の Scaladoc の問題だと思いますが、現時点では何が欠けているのかわかりません。誰でもこの問題について洞察を得ることができますか?
上記のスニペット (報告された問題の 1 つ) は、私のプロジェクトのファイルの一部です: https://github.com/rcsenkbeil/scala-debugger/blob/master/scala-debugger-api/src/main/scala/ org/senkbeil/debugger/Debugger.scala#L22
実際の一連の Scaladoc コンパイル エラーは次のとおりです。
scala - scaladoc にコード例を追加する
ScalaDoc にコード例を追加するための標準的な規則 (またはタグ) は何ですか? 以下のコードの例では、その使用法を示すためにコーディング例を提供したいと思います:
javadoc と同様に、@codeが使用されます。
scala - scaladoc の [[importedName]] へのリンクであり、完全修飾名ではありません
完全修飾名を使用せずに、scaladoc でインポートされた名前 (別のパッケージにある) へのリンクを作成する方法は?
例:
ファイル 1
ファイル 2
しかし、私はドキュメントに入れたくありません[[com.pany.pck1.subpck.Class1]]
。
必要に応じて、次のように Class2 ドキュメントの最後に ref を付けてもかまいません。
scala - Scaladoc ダイアグラム
Scaladoc と SBT で図を生成することは可能ですか?
私は私の中にこの行を追加しようとしましたbuild.sbt
:
scalacOptions in (Compile,doc) := Seq("-diagrams", "-diagrams-debug")
しかし、私は受け取ります: ダイアグラム生成の実行時間の内訳:
「壊れたイメージ」に関する詳細なログを取得するにはどうすればよいですか?
ありがとう。
編集:
コマンドlast
は私を示しています:
scala - Scaladoc、SBT、ケース クラス、および scala バージョン 2.11.x
ケースクラスを持つ Intellij IDEA SBT プロジェクトで scala 2.11.7 の scaladoc を生成するときに問題があります。たとえば、次のコードを使用します。
scaladoc を生成しようとすると、例外がスローされます: エラー:
この例では、scaladoc は正常に生成されますが、私が持っている別の大きなプロジェクトでも、このエラーがスローされ、何も生成されません。これは 2.10.4 を使用する sbt と 2.11.7 を使用する私のプロジェクトの問題でしょうか?
scala - Intellij IDEAでScalaを使用してブロックコメントの配置を変更するにはどうすればよいですか?
現在、Intellij IDEA がブロック コメントをオートコンプリートすると、たとえば と入力する/**+<return>
と、IDEA は次のようにブロック コメントを作成します。
/**
* Comment goes here
*/
ただし、scaladoc は、ブロック コメントの本文を別の方法で配置することを推奨しています。
/**
* Comment here
*/
(空白の違いに注意してください)。
これはどのように構成されていますか?