Можно ли комментировать локальные переменные Visual Studio [нельзя]?

Question

[Alex XYZ]

Всем привет.



?

Comments

[Иван Филатов]

Боже, какую я только дичь не видел в жизни - но для локальной переменной ))

Answer 1

[Foggy Finder]

Если вы имеете ввиду xml-документацию, то нельзя.

Локальные переменные - детали реализации. Старайтесь давать самодокументируемые названия, а сложные участки кода дополнительно сопровождайте комментариями.

Comments

[Alex XYZ]

Всегда есть потребность в странных вещах, стиль кодирования тут не при чём.

Вот представьте, что у вас расчёт на 200 переменных. В моём случае эти переменные пришли из внешней системы, в которой меня забыли спросить, как я хочу их назвать. Таких моделей несколько штук. Мне бы в коде прокомментировать эти имена, например:
B_STOLB // ширина стойки,
B_STOYKA // длина стойки
И таких 200 шт. Строительные модели они такие забавные.
Вот хорошо бы им как раз коммент написать, но вот беда - все советы - "а подроби код на методы?" Как буд-то мне от этого легче будет? Имена переменных я же не могу поменять, чтобы потом не офигевать, а на какую переменную я это спроецировал?

[Foggy Finder]

Вот представьте, что у вас расчёт на 200 переменных. В моём случае эти переменные пришли из внешней системы, в которой меня забыли спросить, как я хочу их назвать.

Можно маппить в собственный тип данных и работать с ним. Возможно такой способ покажется избыточным, но зато код будет легче восприниматься.

[Alex XYZ]

Foggy Finder, Если уж нет встроенной возможности, то и ладно. Видимо ничего не поделаешь. В моём случае такое проксирование действительно слишком накладное, т.к. потребует полного наименования всех переменных, а это лишняя работа, да и поддержка будет просто адовая. Эти переменные используются в трёх-четырёх системах, я думал, ну вдруг я хоть у себя смогу с ними норм работать. Хорошо хоть есть встроенная функция nameof(var_name). Уже дофига проблем решает.

Answer 2

[ddd329]

Ну если только один строчный комментарий. А вообще это очень плохая практика, т.к. из названия должно быть понятно что это за переменная и для чего она предназначена. Ну и соответственно нужен какой-то контекст, где это переменная используется.
Если у вас в коде визуальной формы объявлена переменная total или sum например, то конечно не понятно будет для чего они тут, а если например они объявлены в классе ЗАКАЗ, то тут понятно что это сумма заказа, т.е. мы поняли это из контекста объявления переменных...

Comments

[Alex XYZ]

Вот есть у вас две хорды в окружности. Назовите их так, чтобы было понятно, какая из них какая, чтобы было сразу понятно с какой вы имеете дело? )

[ddd329]

// вот напишите комментарий

[Alex XYZ]

ddd329, может я хочу странного, но лично я предпочитаю такие комментарии:

с такими возможностями:

Answer 3

[Eatric]

Не думаю, XML документацию используют только для описания классов, свойств и методов. В чём смысл документировать локальную переменную?
Руководство

Comments

[Alex XYZ]

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