Haddockを使用してドキュメントの複製を減らす方法

私は非常によく似た2つの機能を持っていますが、どちらも同じドキュメントが必要です。コメントの重複を避ける方法がありますか？Haddockを使用してドキュメントの複製を減らす方法

Haddockのドキュメントでこの機能の説明が見つかりませんでしたが、そうする方法があります。

たとえば、Javadocでは、{@inheritDoc}とがあります。 Haddockはどうですか？

2017-01-18 klappvisor

私は私がやったことはありません（あなたがそのためにドキュメントの名前チャンク（https://www.haskell.org/haddock/doc/html/ch03s05.html）を使用することができると思ったが、私は時々とき、私ハドック文句見ます" - $ foo"のようにドルをコメントアウトする）。チャンクの名前を定義することはできますが、覚えておくと、エクスポートリストでのみ使用し、コメントのbeginngにする必要があります。 – d8d0d65b3f7cf42

機能が密接に関連している場合は、ドキュメンテーションを複製しないでください。代わりに、他の機能のマニュアルを参照してください。次に、タイプによってのみ異なる場合は、1つの説明とわずかに異なるタイプのシグネチャを持つ2つの機能が表示されます。 – Cirdec

残念ながら、関数宣言では、現時点では、Haddockのドキュメントを再利用することはできません。これを追跡するのはissueです。

-- $chunk_nameドキュメントchunk namingは、モジュールのドキュメント、つまりエクスポートセクションでのみ使用できます。これは、モジュールの上から下に文書を移動して混乱を減らすのに便利です。この問題の

一般的な回避策は以下のとおりです。

同様の機能がスコープ内にあることを確認してくださいANドキュメントにこれを追加します。それは十分に小さい場合 -- | See `functionName`. OR -- | See 'functionName'.
または手動でコピーして貼り付けの文書、同様にどのようにそれはbytestringパッケージとvectorパッケージで行われます。

出典

2017-01-18 20:58:10

はい、docを参照する唯一の方法は ' - | 'function_name'を参照してください。この例では答えを広げることができます – klappvisor

良い点、私は編集を行います。 –

Haddockを使用してドキュメントの複製を減らす方法

答えて

関連する問題