代码文档中路径的可变元素的最佳方法？

Question

路径的某些元素通常是可变的，但是整个路径需要以某种方式记录以后的程序员。尤其是在使用 *nix系统时，几乎任何字符都是路径的有效符号。鉴于此，我想划定我的路径的可变部分，以防止误解，但是以一种在不同的显示环境（尤其是浏览器）中也可以最佳地生存的方式。

我看到的方法包括（用户主目录中的路径）：

• /家/u003Cusername> /foo-需要特殊的Web浏览器上下文
• /home/your_username/foo-不幸的是，变量元素往往会被忽略
• /home/{username}/foo
• /home/：用户名/foo

您最频繁地看到哪些人或最成功的成功？为什么？如果是双定界线方法（似乎是最常见/成功的方法），什么是导致您选择的定界符？

Answer 1

到目前为止，我见过（并用过） /home/<username>/foo 最多。不必担心此类评论的特殊逃脱，因为 您的所有代码 在浏览器中显示这些角色时，需要将这些角色逃脱（您很可能有像 echo "<table>"; 在您的代码中。

如果由于某种原因无法逃脱，则可以用空格或下划线包围该术语以防止HTML解析：

/home/<_username_>/foo

强调的一个附加好处是，某些标记（例如Markdown）会自动使其斜体化：

/家/用户名>/foo

使它们在文本编辑器中可以理解，并且在网页中格式很好。

Answer 2

我会说＃1是最清晰的，最常用的是最常用的。 <and>的划界很好，清楚地表明应该在那里替代某些东西。