Стиль комментариев: Императив или от третьего лица

У меня есть вопрос, касающийся программирования и английского языка: использовать ли от третьего лица или императив при комментировании отдельных строк кода. Предположим, что следующая строка кода на императивном языке должна быть прокомментирована:

object.doSomething();

Мой подход к прокомментированию этой строки состоял бы в том, чтобы поместить комментарий за ней с использованием третьего лица, как это было бы обычным английским предложением, содержащим строку в качестве темы:

object.doSomething(); // does (referencing to the line of code) some action

Но поскольку мы находимся на императивном языке и, таким образом, фактически "управляем" компьютером, можно даже подумать о том, чтобы поставить комментарий перед кодом и использовать императив:

//Do some action:
object.doSomething();

Это даже полезно, когда нужно прокомментировать несколько строк, относящихся к каждой Другие.

Лично я предпочитаю первый стиль, но часто не уверен, какой стиль использовать. Было бы здорово, если бы некоторые могли записать здесь свой личный опыт.

18
задан Sebastian Hoffmann 18 January 2012 в 12:38
поделиться