たとえば、この関数は...
int preg_match_all ( string $pattern , string $subject [, array &$matches [, int $flags = PREG_PATTERN_ORDER [, int $offset = 0 ]]] )
文字列$pattern
とを取ります$subject
。しかし、何[
ですか?
これが、関数のドキュメントがオプションの引数を示している方法です。
これは、Unix システムの使用メッセージからの古い規則です:
Unix ライクなプラットフォームでは、使用メッセージは、ユーザーが慣れ親しんでいる一般的なパターンに従う傾向があります。多くの場合、"Usage:" (おそらく名前) で始まり、コマンドであり、その後に引数のリストが続きます。オプションの引数を示すために、角括弧が一般的に使用され、一緒に指定する必要があるパラメーターをグループ化するためにも使用できます。排他的なパラメーターは、グループ内の垂直バーで区切って示すことができます。
以下は、NetBSD ソース コード スタイル ガイドに基づいた完全な例です。
使用法: プログラム [-aDde] [-f | -g] [-n 番号] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]
これは、「プログラム」を次のように呼び出す必要があることを示します。
- オペランドのないオプション: a、D、d、e (いずれも省略可能)。この場合、一部のパラメータでは大文字と小文字が区別されることに注意してください
- 排他的オプション: f、g (縦棒で示されます)
- オペランドを持つオプション: n
- オペランドを持つ排他的オプション: b、c
- 必要な引数: req1、req2
- オプションの引数 opt1。opt2 の有無にかかわらず使用できます (別の角括弧のセットを使用して、グループ内でオプションとマークされています)
- オプションの引数 opt2。これには opt1 が必要です