Лучший способ разграничить переменные элементы пути в кодовой документации?

Question

Часто какой -то элемент пути является переменным, но путь в целом должен быть задокументирован каким -либо образом для более поздних программистов. Особенно при использовании *NIX Systems практически любой символ является допустимым символом для пути. Учитывая это, я хотел бы разграничить переменные части моего пути, чтобы предотвратить недоразумение, но в некотором смысле, что также выживает лучше всего в различных средах отображения (особенно браузер).

Методы, которые я видел, включают в себя (пример пути в домашний каталог пользователей):

• /дом/u003Cusername> /foo - требует специального побега для контекста веб -браузера
• /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 - самое ясное, и то, что, вероятно, используется чаще всего. <И> Delimit Это хорошо, и четко указывают на то, что что -то должно быть заменено там.