問題タブ [docco]

Grunt ワークフローのプロジェクトで docco を実行する grunt-docco ( https://github.com/DavidSouther/grunt-docco ) を使用しています。

ただし、使用されているMarked ( https://github.com/chjj/marked ) にオプションを渡すことに関する問題 ( https://github.com/DavidSouther/grunt-docco/issues/34 )に遭遇しました。ドッコの内部。

私の質問は、docco インスタンスを作成するときに、マークされたオプションを渡す方法はありますか? docco がこのようなことを行うためのドキュメントは、私には完全に明確ではありませんが、何らかの方法があるに違いないことはわかっています。

できれば助けてください！grunt タスクのスタック トレースは次のとおりです。

パッケージ ( Knitr )でサポートされているDOCCO線形スタイルを使用してパッケージのビネットを書こうとしていました。knitr

彼らのビネットの例では、HTML ファイルの最初と最後に素敵なグラフィックが表示されます。

しかし、私が自分のビネットを維持しようとしたとき、それらのグラフィックは表示されず、代わりに巨大な文字が表示されました8: hP 以下のように: .

なぜこれが起こっているのか、これを修正する方法を教えてもらえますか?

書き込んだビネットを次の構文.Rmdを使用して変換しています。.HTML

ビネット:

これを変換する関数：

npmコンピューターにインストールしておく必要があることに注意してください。

ターミナル経由でインストール:

次に、docco をインストールします。

アドバイスをありがとう！

編集：

まず、マークダウン コンパイルの後、Windows で docoo をダウンロードしてインストールできなかったため、vignette ファイルが作成された Oracle Virtual Machine の ubuntu の firefox で自分のビネット ファイルを開きました。8出力ファイルに醜く表示されます。

しかし、このファイルを電子メールで自分に送信し、Windows で開いたところ、作成時に望んでいたとおりに完全に見えました。以下をチェック

それで、firefoxの仮想マシン上のubuntuでdoccoスタイルを説明するknitr vignetteマニュアルを開いたところ、同じ8記号が表示されます!

ある種のエンコーディングの問題だと思いますか？私は正しいですか？Windowsに送信した後、うまく機能し、見栄えがします。1日のほとんどを失ったこのナンセンスを誰か1人が説明できますか?

ありがとう ：）

目的は、 doccoが生成したfluentnodeのドキュメント(Coffee-Script で記述) をできるだけ読みやすく、理解しやすいものにすることです。現時点では、 http://o2platform.com/fluentnode/index.htmlでアクセスできるヘルプ ページの左側にある関数名を表す最善の方法に苦労しています。

現在、次の 3 つの構文オプションを検討しています。

あ）@. {関数名} ({params}) B) {クラス名}:: {関数名} ({params}) C) {クラス名}# {関数名} ({params})

例として、Array の .empty()メソッドは次のように表されます。

あ）@. 空()

B) 配列::空()

C) 配列番号空()

これは特定のクラスのファイル内で見られることに注意してください (したがって、これが配列に関連していることは A でも明らかです)。

これを実際に確認するために、3 つの異なるヘルプ ファイルでこれらの方法論を使用しました。

あ）@. Array.htmlの {関数名} ({params})

B) {ClassName}:: Function.htmlの{関数名} ({params})

C) {ClassName}# {関数名} ({params}) on C) http://o2platform.com/fluentnode/Number.html

ところで: これを表す他の方法がある場合は、それらの手法を表す既存の docco 生成サイトを教えてください。

(ここでも質問されます https://github.com/o2platform/fluentnode/issues/31 )

Pycco に doctest をコードとして認識させ、適切にレンダリングさせる方法はありますか?

たとえば、次の関数のドキュメント文字列

次のようにPyccoでレンダリングします

明らかに>>>インデントとして解釈され、コードの強調表示が機能しませんでした。これは一般的な使用例のようです。私が行方不明のプラグインはどこかにありますか？

私たちの組織は、コードの品質を管理するために SonarQube を使用し、コード コメントからのドキュメントの作成を処理するために Docco を使用しています。

Docco のコメントにメソッド名などを含めることと、SonarQube の「コードのセクションを「コメントアウト」してはならない」というルールとの間で競合が発生しています。

SonarQube がドキュメント用のコメント内のコードを無視するようにするための既知のベスト プラクティスはありますか (特に Docco の場合はさらに優れています) が、削除される代わりにコメント アウトされた古いコードを引き続きキャッチしますか?