code-documentation

1熱

1答えて

緩い拡張モジュールを持つJSDocが一部のアイテムを解析しない

緩い拡張を使用するモジュールにjsdocドキュメントを追加する適切な方法は何ですか？あるいは、実装を間違って設定するだけですか？最終的に私の共有メンバーが最終的な文書に含まれることを期待しています。 ルース拡張モデル（as described here）を使用して作成したモジュールでJSdocを使用しようとしています。モジュールはのラインに沿っている：私はこのコードでJSDocのを実行すると /*

javascript module documentation-generation jsdoc code-documentation 2017-01-11

---

1熱

1答えて

Doxygenがマークダウンコードブロックで自動リンクを生成しない

doxygen 1.8.13を使用して、マークダウンコードで自動リンクを生成するにはどうすればよいですか？ TEST.H /** * Function foo. * This is a code snippet in markdown format: * * foo("Hello World!!!"); * * This is a regular code snippet: *

markdown doxygen code-documentation 2017-01-16

---

1熱

1答えて

派生クラスのXMLドキュメントのコメントタグ内から、基本クラスのアクセシブルなメンバーを参照できないのはなぜですか？

は、私がこれを持って言う：なぜ私は<see/> XMLコメントタグから、基底クラスで定義されIsExtinctプロパティを参照しようとすると、エラーを取得しています internal abstract class Animal { internal bool IsExtinct { get; set; } } internal sealed class WoollyMammoth

c# code-documentation 2017-06-15

---

2熱

1答えて

NoMethodError：未定義のメソッド `match？ ' "Ruby"の場合：String

ユーザーからの入力がRegEx [a-zA-z]と一致するかどうかを確認しようとしていますので、適切な方法についてドキュメントを確認しました。私はRuby-doc.orgでmatch?を発見し、IRBのドキュメントに示されている例をコピーし、代わりにtrueの私は、この取得しています： 2.3.3 :001 > "Ruby".match?(/R.../) NoMethodError: undef

ruby regex match nomethoderror code-documentation 2017-01-22

---

-1熱

1答えて

scikit-learnのウェブサイトを構築するために使用されたフレームワーク

scikit-learnは非常に整理されたウェブサイトであり、ソースコードを文書化するためのきれいな方法です。ウェブページは自動的に生成されますか？これらのページを作成するフレームワークはありますか？ どのフレームワークが使用されているかを知ることで、私が所有する他の同様のリポジトリをドキュメント化するのに役立ちます。

scikit-learn documentation-generation web-frameworks code-documentation 2017-08-10

---

0熱

1答えて

Visual StudioコードにGhostDocのアナログがありますか？

私はVSコード（C＃）用のGhostDocのようなものを探していますが、無駄です。誰もが何も知らない？ an "old" VS-like extensionは、「///」と入力したときにXMLコメントが表示されることがわかりましたが、私が探しているものではありません。

visual-studio-code code-documentation 2017-06-24

---

0熱

1答えて

APIとJava

私はSedgewickとウェインの最初の章アルゴリズム（およびJavaでのプログラミングに入門の最初の2つの章）を読んでいるの関数/クラスの宣言。 APIが何を意味するのか分かりません。次は本からの抜粋です。 次のように例が与えられている：：ここ は私質問です JavaコードのAPIの一部ですか？ APIは関数/クラスの宣言とどのように異なるのですか？

java api code-documentation 2017-08-13

---

-2熱

1答えて

C＃プロジェクトのソースコードの品質に関する文書ですか？

私は層（API、ドメイン、リポジトリ、DTO、エンティティ）を含むWeb APIプロジェクトで作業しています。各レイヤーのソースコードを文書化したい。 私は、各レイヤーの各機能についてコメントを始めました。それは良い方法ですか？ 私のソースコード（c＃プロジェクト）の正確で専門的な品質の文書を作成し維持するための最良の手法またはツールはどれですか。

c# code-documentation 2017-08-16

---

-1熱

1答えて

抽象クラスを継承するコンストラクタをjavadocする方法

複数のものを何度もコピーすることなく、できる限りクリーンな方法でJavaコードを文書化しようとしています。ここでは、私は私が欲しいものを説明しましょう、私が持っているものの一例である： public abstract class Toto <S extends Number>{ /** * Defined value */ protected S myVa

java javadoc code-documentation 2017-10-16

---

0熱

1答えて

Alexandria Lispマニュアル＆インプリメンテーション

ALEXANDRIAパッケージは、Common-Lispコミュニティで広く使用されているようです。しかし、私が見つけた唯一のマニュアルは、マニュアルの草案です。これは2つの質問につながります。 1）のようないくつかのマクロがあります。これらは "Conses"の見出しの下にありますしかし、これも一般的には「順序」のために働くように見える： (defparameter vec (vector 1 2

package common-lisp code-documentation 2017-02-10

---