Я некоторый код, который имеет комментарии после каждого метода говоря это, например:Комментарии в конце метода лучшей практики?
// End of contructor DbFactoryDBConnection()
Если комментарий, как это можно использовать, чтобы указать конец метода или нет? Это было чем-то вроде того, что было раньше, когда это было обычным местом.
Я чувствую, что такие комментарии после методов, которые не подходят ни одному экрану. Я считаю, что это хороший знак для рефакторинга и разделения таких длинных методов, чтобы сократить или даже извлечь новые сущности/службы/помощники. Это похоже на область C#, иногда она используется, чтобы скрыть очень длинные блоки кода, и это признак того, что у вас есть какой-то God Object anti-patter.
№. Если вы хотите узнать, какие фигурные скобки закрываются, без прокрутки, вы можете иметь ReSharper. Это здорово во многих отношениях.
Просто наведите курсор на фигурные скобки, и если их открытие не отображается, оно всплывает перед всей строкой.
Я думаю, что такого рода комментирование совершенно не нужно, и только служит для загромождения кода. Большинство IDE (например, Visual Studio) имели функции для выделения области действия метода (или любого другого) в течение многих лет, поэтому я не уверен, какое значение вы могли бы добавить в свой код, выполнив это.
Нет, такой комментарий не должен использоваться. Единственная причина, кто-то использовал бы комментарий, так это то, что метод способ слишком длинный. Но даже, чем современные современные среды IDE показывают вам где-нибудь, в каком методе вы сейчас находитесь, и даже позволяют использовать методы складывания только для определения.
Подобные комментарии не имеют никакой ценности и просто загрязняют базу кода.
Обычно такие комментарии представляют собой проблему с передокументацией.
Правильное место, где должны существовать комментарии, находится в начале ваших классов и ваших методов и непосредственно перед тем, когда в вашем коде будут приняты важные решения.
Если вам необходимо документировать конец IF, SWITCH или METHOD, то очень вероятно, что ваш код должен быть пересмотрен, чтобы быть упрощенным.
Это не относится к источнику ИМХО; слишком легко выйти из синхронизации с эффективными блоками исходного кода. Есть расширения, которые покажут эту информацию для вас в Visual Studio, и вы поняли, что это полезно.
Вы всегда можете использовать PowerCommands для Visual Studio это добавить в конце скобки комментарии, что наручи конца вы в я использую его, и это очень помогает :)
Личного мнения: Тьфу, нет. Современные IDE имеют синтаксис и подсветку структуры, которая подходит для этого. Зачем загрязнять код комментариями, которые не добавляют никакой ценности? – dash
Личное мнение: Что сказал @dash. Единственная причина, по которой я вижу, - это метод, охватывающий более одного экрана, и в этом случае вы можете улучшить ситуацию, чтобы улучшить ситуацию. –
Хорошо, что подтвердило мои подозрения. Они будут удалены. Благодарю. – CSharpened