
Другие языки программирования и технологии
Скажите пожалуйста, стоит ли так комментировать код, нормально ли это, или не стоит всё подробно расписывать?
Как бы Вы отнесли к таким комментариям, было бы Вам приятно читать такой код? Заранее спасибо.


Идеальный код — «самодокументированный», то есть с правильно подобранными названиями и чётким формулированием мыслей. Это всё приходит с практикой обычно.
Просто старайтесь разбивать код на небольшие логические куски, использовать в именованиях один стиль (то есть просто пишите всё на английском, никакого транслита ни в коем случае).
Если применяются какие-то неочевидные решения, их вполне можно вынести в комментарий в начале блока. Но каждую строчку комментировать — это перебор и допустимо только на самых первых этапах обучения.
Просто старайтесь разбивать код на небольшие логические куски, использовать в именованиях один стиль (то есть просто пишите всё на английском, никакого транслита ни в коем случае).
Если применяются какие-то неочевидные решения, их вполне можно вынести в комментарий в начале блока. Но каждую строчку комментировать — это перебор и допустимо только на самых первых этапах обучения.
Вадик Денисенко
Тогда лучше уберу эти комменты)))
Комментарии внутри функции совершенно лишние: формализованного комментария перед функцией более чем достаточно.
Внутри функции надо комментировать только нетривиальные места, смысл которых сложно понять. У тебя же всё полностью понятно из самого кода.
Внутри функции надо комментировать только нетривиальные места, смысл которых сложно понять. У тебя же всё полностью понятно из самого кода.
Вадик Денисенко
Благодарю
Вадик Денисенко
Я знаю что Вы хорошо разбираетесь по языку GO хотел бы посоветоваться по этой проблеме https://otvet.mail.ru/question/218683897 туда ответьте как будет свободное время.
В коде 3 комментария. По порядку:
1. Обычно ни в имени метода, ни в комментарии к нему не пишут о том, какой алгоритм он использует, если только это не какая-нибудь лаба про разные алгоритмы.
size лучше переименовать в arraySize.
ОСНОВНАЯ ИНФОРМАЦИЯ О КОДЕ ДАЕТСЯ САМИМ КОДОМ: именами параметров, методо и т. д.
А разве в этом языке нельзя получить размер массива в самом методе?
2. В комменте написано то же что в комментируемой строчке и ничего нового. Так быть не должно.
3. Комментарий по самому алгоритму был бы не лишним в этом месте, но из имеющегося мне (незнакомому с алгоритмом) неясно, почему этот if - это "если минимальный элемент расположен в неотсортированной части".
1. Обычно ни в имени метода, ни в комментарии к нему не пишут о том, какой алгоритм он использует, если только это не какая-нибудь лаба про разные алгоритмы.
size лучше переименовать в arraySize.
ОСНОВНАЯ ИНФОРМАЦИЯ О КОДЕ ДАЕТСЯ САМИМ КОДОМ: именами параметров, методо и т. д.
А разве в этом языке нельзя получить размер массива в самом методе?
2. В комменте написано то же что в комментируемой строчке и ничего нового. Так быть не должно.
3. Комментарий по самому алгоритму был бы не лишним в этом месте, но из имеющегося мне (незнакомому с алгоритмом) неясно, почему этот if - это "если минимальный элемент расположен в неотсортированной части".
Вадик Денисенко
Это язык C так нету методов типа как в языке php len() или свойства array.length именно поэтому в функции передается массив и его размер. Но спасибо за ответ.

Похожие вопросы
- Пожалуйста помогите разобраться с даним кодом C++. Тема : Односвязание списки
- Как грамотно комментировать код C/C++. Есть ли какие нибудь стили или стандарты?
- Здравствуйте всем! Помогите пожалуйста найти ошибку в моем коде
- Скажите мне пожалуйста, стоит ли изучать программирование, если...
- Программисты! Помогите пожалуйста! Нужно на паскале написать код к следующей задаче: Даны натуральные числа a, b, c
- Подскажите пожалуйста, стоит ли обучаться на программиста? Есть ли перспективы?
- Комментируете ли вы свой исходный код? Почему?
- Люди напишите пожалуйста подробно ! как узнать исходный код программ и игр ? Заранее благодарен .
- Нарисуйте пожалуйста блок схему к коду, что бы были видны блоки, картинкой прикрепите или любой удобный формат.Подробно
- HTML! помогите пожалуйста написать код для сайта простого сайта!