Страницы

Поиск по вопросам

четверг, 9 января 2020 г.

Правильные названия классов в Java [закрыт]

#java


        
             
                
                    
                        
                            Закрыт. На этот вопрос невозможно дать объективный ответ.
Ответы на него в данный момент не принимаются.
                            
                        
                    
                
                            
                                
                
                        
                            
                        
                    
                        
                            Хотите улучшить этот вопрос? Переформулируйте вопрос,
чтобы на него можно было дать ответ, основанный на фактах и цитатах, отредактировав его.
                        
                        Закрыт 2 года назад.
                                                                                
           
                
        
Всем привет.
Страдаю от неумения правильно придумывать названия своим классам. От этого так же
страдают и коллеги=)

Вот есть какой нибудь сборник правил как назвать правильно класс. Понятно что он
должен раскрывать суть работы класса, но то как я понимаю его работу может отличаться
от того как его работу понимает коллега. Это от части говорит что сам класс не правильно
спроектирован но тем не менее.

Вот допустим, у меня есть класс который нужен мне для того чтобы сгенерировать html
страницу, и поместить ее в темповую директорию jboss, чтобы метод REST возвращал ссылку
на эту страницу.

Собственно, я назвал класс buildingList.class
Все работает четко, но название блин не могу придумать.
    


Ответы

Ответ 1



Ну вроде бы написали все верно, тем не менее элемент недосказанности остался - спешу восполнить пробел (по следам документа Java Naming Convention и своего опыта): Имена классов: начинаются с большой буквы и должны состоять из существительных, типа BuildingList в стиле CamelCase Имена интерфейсов: начинаются с большой буквы и должно быть прилагательным, типа: Buildable - тоже в стиле CamelCase Имена методов: начинаются с маленькой буквы и должны быть глаголами (в стиле CamelCase), типа: buildList Имена переменных: начинаются с маленькой буквы, типа: myList - в стиле CamelCase Имена пакетов: все маленькими буквами, типа: com.builder.list - не в стиле CamelCase, принято именовать пакеты доменным именем владельца, типа: ru.padawan.builder.list, хорошим тоном считается регистрация своего доменного имени и активно применять свое доменное имя с именами пакетов. Имена констант: все большими буквами, типа: MY_LIST_CONSTANT - стиль CamelCase не применяется, слова разделяются нижним подчеркиванием. CamelCase (буквально верблюжий регистр) - это когда каждое новое слово пишется с большой буквы, типа: HereIsCamelCaseExampleName - ЭтоПримерВерблюжьегоСтиляИменования

Ответ 2



Почитайте БЭМ (Блок-Элемент-Модификатор) вот как пример статьи: https://ru.wikipedia.org/wiki/%D0%91%D0%AD%D0%9C https://ru.bem.info/methodology/

Комментариев нет:

Отправить комментарий