Должны ли комментарии повторяться, если один и тот же код повторяется в одном и том же файле? - PullRequest
0 голосов
/ 25 апреля 2020

Если я повторно использую один и тот же код в нескольких местах / функциях в одном и том же файле, следует ли размещать одни и те же комментарии снова и снова или только один раз? Меняется ли протокол / стандарт практики кодирования для комментариев с каждым языком?

Ответы [ 2 ]

1 голос
/ 25 апреля 2020

Меняется ли протокол / стандарт практики кодирования для комментариев с каждым языком?

Не совсем, я программировал на нескольких языках, и мой менталитет комментариев не изменился.

Если я повторно использую один и тот же код в нескольких местах / функциях в одном и том же файле, должен ли я размещать одни и те же комментарии снова и снова или только один раз?

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

Вы должны только комментировать то, что не указано в вашем код. Если в вашем коде вы повторяете один и тот же блок кода в нескольких местах, то это не очень хорошая практика, и вы должны использовать functions (как сказал @Joseph Sible-Reinstate Monica), чтобы поместить ваш повторяющийся код в блоки оператора, чтобы затем повторно использовать его, вызывая функцию. Также, если вы повторяете код одной функции в другой, помните, что вы можете вызывать функцию внутри другой функции, чтобы избежать дублирования кода . Поэтому, если вы сделаете последнее, то можете просто прокомментировать, что делает основная функция, и когда пользователь увидит эту функцию, например, в другой функции, он может go вернуться в ваш код и проверить комментарий для исходной функции.

Кроме того, есть ли аспекты кода, которые следует или не следует комментировать в соответствии со стандартной практикой?

Опять только комментируйте то, что не указано в вашем коде, если у вас есть например, функция, которая просто отображает текст, тогда ей не нужно комментировать, но если, наоборот, ваш код использует внешние зависимости или ваши собственные классы, то хорошей практикой будет комментировать, какова их роль в вашем коде; По сути, объясняя, как ваш код использует эти ресурсы.

1 голос
/ 25 апреля 2020

Mu . Вы не должны повторять такой код вообще. Рефакторинг его в функцию, поэтому вам нужно написать его только один раз.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...