コードドキュメントのパスの変数要素を区切る最良の方法は？

Question

多くの場合、パスの一部の要素は可変ですが、パス全体として、後のプログラマーのために何らかの方法で文書化する必要があります。特に *nixシステムを使用する場合、ほとんどすべての文字がパスの有効なシンボルです。それを考えると、誤解を防ぐために自分のパスの可変部分を区切りたいが、異なるディスプレイ環境（特にブラウザ）でも最高に生き残る方法で。

私が見た方法には（ユーザーのホームディレクトリの例のパスの例）：

• /家/u003Cusername> /foo-ウェブブラウザのコンテキストには特別なエスケープが必要
• /home/your_username/foo-残念ながら変数要素は見落とされる傾向があります
• /home/{username}/foo
• /home/：username/foo

最も頻繁に見たことがありますか、それとも最も成功したのですか？その理由は何ですか？ダブルデリミターメソッド（これが最も一般的/成功していると思われる）の場合、選択者の選択をリードするものは何ですか？

Answer 1

私ははるかに見た（そして使用した） /home/<username>/foo 最も。そのようなコメントのために特別な脱出を心配しないでください すべてのコード ブラウザに表示されたときにそれらの文字を脱出させる必要があります（あなたは非常によく持っているかもしれません echo "<table>"; あなたのコードで。

何らかの理由で脱出が不可能な場合は、HTMLの解析を防ぐために、スペースまたはアンダースコアで用語を囲むことができます。

/home/<_username_>/foo

アンダースコアの追加の利点の1つは、一部のマークアップ（マークダウンなど）が自動的にイタリック体化することです。

/家/ユーザー名>/foo

それらをテキストエディターで理解しやすくし、ウェブページでうまくフォーマットされています。

Answer 2

＃1が最も明確であり、おそらく最も頻繁に使用されるものだと思います。 <and>はそれをきれいに区切り、そこに何かを置き換えるべきであることを明確に示しています。