codestyle

Стиль кодирования проекта

• весь код приложений для Андроид должен лежать в braille4/android/ (см. ветку dev)
• Отчёты и документация помещается в папку doc

Некоторые правила оформления кода на Kotlin, которых мы будем придерживаться:

1. CamelCase: если в названии несколько слов, следующее начинается с заглавной буквы. Имена классов начинаются с заглавной буквы, переменных и функций - со строчной, например class BrailleSymbol, fun printBraille, var brailleSequence.
2. Отступы обозначаются 4 пробелами
3. длина строки - 160 символов, более длинные переносим
4. комментарии к коду можно оставлять на русском или английском языке. Комментарий должен описывать текст, закомментированный код коммитить не надо.
5. Хардкод: нежелательно использовать безымянные константы в коде (кроме разумного использования 0, 1). В тестах в разумных пределах хардкод допустим.

В случае сомнений можно посмотреть официальный стиль кодирования языка Котлин

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