コード内に作成したPowerShellコマンドレットがdocumentationです。 1つのこと以外はすべて正常に動作します。ドキュメントのセクションの説明が長い場合は、複数の行に分割して、コードから簡単に読むことができます。しかし私は、これらの改行文字がPowerShellシステムの新しい行としても表示されることに気付きました。私は私のようなものを得るでしょうコメントのこの種が含まれているコマンドレットにGet-Help
を実行した後PowerShellコマンドレット複数行コードのドキュメントと行の折り返し
は例として、ここでは今、ドキュメント
.PARAMETER MyParam
This parameter has a long documentation that does not fit into single line,
so I'm breaking it down to several lines.
の一部です。
-MyParam [<SwitchParameter>]
This parameter has a long documentation that does not fit
into single line,
so I'm breaking it down to several lines.
Required? true
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
最初の行が正しく包まれたが、その後(ワードso
で始まる)は、第2の行は、新しい行で開始されることを注意してください。
私はドキュメント全体を1行にまとめることでこの問題を克服できましたが、読みやすさの点ではそれほど優れていません。
ドキュメンテーションブロック全体を同じテキストブロックの一部として扱いますが、複数の行にまとめられたコメントを同時に扱う方法はありますか?文書で、私が新しいパラグラフをつくるつもりはなく、前のパラグラフを続けたいと言うことができる方法はありますか?
最高の私の姿は、あなたの弦を取り、それを折り畳むことです。私は限界が何であるかわからないが、60は安全な賭けになるかもしれない。そうすれば、コードとヘルプの両方で同じように見えます。http://stackoverflow.com/questions/28243543/equivalent-of-nix-fold-in-powershell/28244470#28244470 – Matt