Docblock

Docblock

 「Docblock」  
プログラミングでは、docblockまたはDocBlockは、コードの特定のセグメントを文書化するために使用される、ソースコードで指定された特別にフォーマットされたコメントです。これにより、DocBlock形式はターゲット言語に依存しなくなります（コメントをサポートしている場合）。ただし、複数の標準または一貫性のない標準につながる可能性も

コンテンツ
1 実装例
1.1 C＃ 1.2 Java 1.3 PHP 1.4 Python 1.5 ルビー 1.6 さび
2 も参照してください
実装例編集

C＃
///

2つの数値を足し合わせます。 /// 最初の数値。 /// 2番目の数値。< / param> /// 2つの数値の合計。 int Sum （int a 、 int b ）{ return a + b ; }

Java
Javadoc

PHP
<？php / ** * 2つの整数を足し合わせる** @param int $ a最初の整数* @ param int $ b2番目の整数* @ returnint整数の合計$ aと$ b * /関数の合計（int $ a 、int $ b ）：int { return $ a + $ b ; }

Python
def sum （a ： int 、 b ： int ） -> int “” “2つの数値を足し合わせます。 Args：
a：最初の数字。
b：2番目の番号。 戻り値：
2つの数値の合計。 “” ” はa + bを返します

ルビー RDoc ##＃このクラスは、一連の点によって任意の形状を表します。クラス Shape ##＃ + polyline +で記述された新しい形状を作成します。 ＃＃ + polyline +が同じポイントで終了しない場合、 最初にポイントされた＃で開始されたものがコピーされ、行の終わりに配置されます。 ＃＃ 線がそれ自体と交差する場合、ArgumentErrorが発生しますが、形状は ＃凹面である可能性が def initialize polyline ＃… end終わり

さび
/// 2つの数値を足し合わせます。/// ///＃例/// /// “ ` /// let result = sum（5、5）; /// “ ` fn sum （a：u64 、b：u64 ） -> u64 {
a + b }

も参照してください
Docstring –言語固有の不揮発性ドキュメント
ドキュメントジェネレータの比較