Список требований к оформлению исходных кодов:- Именование (особое внимание!). Переменные, классы, поля, методы, файлы, проекты должны иметь понятные (никаких сокращений) и грамотные (с точки зрения английского языка) имена. Используем ВерблюжийСпособИменования. Методы с БольшойБуквы, поля (имена переменных) с маленькойБуквы.
- Форматирование. Единообразно используйте пробелы (табуляция = 4 пробела), расставляйте скобки для блока кода независимо от количества операторов. Следите за пустыми строками: отделяйте логически связанные блоки кода друг от друга, и в то же время не оставляйте висячих пустых строк.
- Длина функций. Запрещается создавать функции и методы длиной более одного экрана.
- Число аргументов. Запрещается создавать функции и методы с числом аргументов больше 5.
- Комментарии. Запрещается использовать комментарии в качестве дезодоранта для плохого кода. Не нужно комментировать код - просто сделайте его понятнее: выберите правильные имена, разбейте на несколько функций, используйте пустые строки.
|