Стиль документации: как Вы дифференцируете имена переменной от остальной части текста в рамках комментария? [закрытый]
3 ответа
ЛЮБОЙ из этих стилей, которые вы упомянули, при условии, что есть последовательность во всей вашей документации.
В приведенном примере комментарий в сочетании со строкой кода, который комментируется, обеспечивает весь контекст, необходимый для понимания того, что было написано.
Фактически, даже при работе с комментарием, который предназначен для объяснения блока кода, обычно это не проблема - код + комментарий = контекст для понимания .
Все сказанное, и как заметил кто-то другой: пока вы последовательны, любой из выбранных вами методов работает.
99.9% своего времени я занимаюсь PHP, где этой проблемы не существует:
// Try to parse $type.
но когда я делаю некоторые вещи на других языках, мне нравятся одинарные кавычки (но я думаю, что не очень важно, что вы используете, но вы должны использовать одно и то же каждый раз, а не менять его в каждом комментарии ;) ):
// Try to parse 'type'.