Последние записи

made in programmersforum 5

Интенсив по Python: Работа с API и фреймворками 24-26 ИЮНЯ 2022. Знаете Python, но хотите расширить свои навыки?
Slurm подготовили для вас особенный продукт! Оставить заявку по ссылке - https://slurm.club/3MeqNEk

Online-курс Java с оплатой после трудоустройства. Каждый выпускник получает предложение о работе
И зарплату на 30% выше ожидаемой, подробнее на сайте академии, ссылка - ttps://clck.ru/fCrQw

3rd
Янв

Рекомендуемые правила оформления кода

Posted by Chas under Общалка

Многие опытные программисты форума частенько жалуются на плохую читаемость кода. Конечно же каждый программист обладает так называемым «почерком» (стилем программирования). Но, согласитесь, у некоторых очень неразборчивые «почерки». Предлагаю тем, кто жалуется, в этой теме тезисно изложить рекомендуемые правила(от себя или где — нибудь общепринятые).

Utkin
1. Практически каждая строка должна иметь поясняющий комментарий (кроме совсем очевидных, вроде end или операторных скобок).
2. Отступы в стиле Олмана — http://ru.wikipedia.org/wiki/%CE%F2%…E0%ED%E8%E5%29
3. Перед функцией/методом/процедурой обязательно:
а) Зачем нужна эта функция/метод/процедура
б) Краткая расшифровка всех входящих параметров
в) Иногда расшифровка результатов (например -1 в случае неверных входящих параметров).
4. Разделяю все методы, классы и прочие важные функциональные единицы программы строкой состоящей из одних слешей типа:
////////////////////////////////////////////////////////////////////////////////////////////////
Ну это на вскидку, может и еще чего делаю . Собственно конкретные детали не так уж и важны, главное чтобы оформление кода вообще имело место.

тема на форуме