Почему стандарты кодирования?
Поскольку большая часть расходов на программное обеспечение тратится на обслуживание, правила кодирования имеют решающее значение. Кроме того, программное обеспечение не часто создается одним человеком. В результате соблюдение стандарта при разработке программного обеспечения улучшает читабельность программы.
Ниже приведены некоторые рекомендации:
- Соглашения об именах. В программировании на Java мы обычно используем соглашение о регистре верблюдов. Это указывает на то, что все классы и интерфейсы должны быть существительными, причем первая буква каждого внутреннего слова в смешанных обстоятельствах должна быть заглавной. Все методы должны быть глаголами, написанными в смешанном регистре с первой буквой в верхнем регистре и первой буквой каждого внутреннего слова в нижнем регистре. Имена переменных должны быть осмысленными, и следует избегать односимвольных имен. В случае капитала определяется постоянная переменная.
- Фигурные скобки. Тело классов, методов и циклов определяется с помощью фигурных скобок. Есть две стандартные формы использования фигурных скобок, и можно использовать любую —
а). Пустые строки не должны находиться ни после открывающей скобки, ни перед закрывающей скобкой.
б). Фигурная скобка применяется в конце строки, которая запускает класс, метод, цикл и т. д., а закрывающая скобка находится на отдельной строке, выровненной вертикально с началом первой строки.
3. Отступ. Уровень отступа должен составлять четыре пробела. Табуляторы должны располагаться ровно через каждые 8 пробелов. Символ пробела должен использоваться для всех отступов, а символы табуляции не должны появляться в конечном исходном файле. Ниже приведен общепринятый стандарт повышения читабельности каждой строки:
а). Делайте отступы для сходных элементов в вертикальном списке (таких как комментарии в конце строки и идентификаторы в объявлениях).
b). Для окружения бинарных операций (включая присваивание) следует использовать пробелы.
c). Пробел должен стоять после точки с запятой или запятой.
d). Между ключевым словом ("if", "while", "return", "catch", "switch", "for") и следующей скобкой добавьте пробел.
e). Лишние круглые скобки также можно использовать для привлечения внимания к структуре фраз (но не используйте слишком много вложенных круглых скобок).
f). Чтобы различать критические части кода, используйте пустые строки.
4. Комментарии. Существует два типа комментариев, которые можно использовать в программах Java. Реализация и документация — это два термина. В комментарии должна быть включена только информация, необходимая для чтения и понимания программы. Например, информацию о том, как собирается пакет или где он хранится, не следует размещать в программе в качестве примечания.
а). Комментарии реализации:/ используется для разделения комментариев реализации. Для комментариев реализации Java дополнительно поддерживает использование /*…*/. Комментарии к реализации используются для наблюдения за конкретной реализацией или для временного удаления кода. Блочный, однострочный, замыкающий и временно исключающий код — это четыре типа комментариев к реализации, которые можно использовать в программах.
б). Однострочные комментарии:могут быть написаны на одной строке с отступом до уровня следующего кода. Если комментарий слишком длинный и не помещается в одну строку, его следует отформатировать как блочный комментарий. Если он не появляется сразу после начала составного оператора, однострочный комментарий должен предваряться пустой строкой.
в). Конечные (очень короткие) комментарии:они могут находиться в той же строке, что и код, который они описывают, но их следует держать на безопасном расстоянии от него. Если блок связанного кода содержит несколько коротких комментариев, все они должны иметь один и тот же отступ на вкладке.
Ссылка: https://www.geeksforgeeks.org/coding-guidelines-in-java/
