Соглашения об именах в Java
Хорошее имя может отражать характеристики, значение или цель кода, чтобы читатели могли быстро прояснить контекст программы в соответствии со значением имени. Формы именования, используемые в разных языках, совершенно разные.В Java есть три наиболее часто используемых формы именования, а именно UpperCamelCase с заглавной буквой, lowerCamelCase со строчной буквой и UPPERCAMELUNSER_SCORE со всеми прописными буквами и словами, разделенными символами подчеркивания. По общему соглашению, классы называются большими верблюжьими буквами, методы и локальные переменные называются маленькими верблюжьими буквами, а символы подчеркивания в верхнем регистре обычно используются в константах и перечислениях.
именование пакетов
Имя пакета всегда пишется строчными буквами, и между разделителями точек есть только одно английское слово с естественной семантикой, или несколько слов естественным образом связаны друг с другом (например, springframework, deepspace не требует разделения). Имя пакета единообразно в форме единственного числа.Если имя класса имеет значение множественного числа, может использоваться форма множественного числа.
Состав имени пакета можно разделить на следующие четыре части [префикс] [имя инициатора] [имя проекта] [имя модуля]. Общие префиксы можно разделить на следующие категории:
Имя класса
В именах классов используется форма именования с большим верблюжьим регистром. Имена классов обычно представляют собой существительные или именные словосочетания. Помимо существительных и именных словосочетаний, в именах интерфейсов также могут использоваться прилагательные или прилагательные, такие как Cloneable, Callable и т. д., указывающие на то, что класс реализация интерфейса имеет какую-то функцию или способность. Для тестового класса он начинается с тестируемого класса и заканчивается Test, например HashMapTest.
Для некоторых специальных и уникальных аббревиатур вы также можете использовать имена, состоящие из заглавных букв, такие как XMLHttpRequest, но автор считает, что аббревиатуры пишутся с заглавной буквы в пределах трех букв, и более трех букв считаются в соответствии со словами, которые должны быть даны. Стандарта для этого не существует, например, fastjson в Alibaba использует JSONObject в качестве имени класса, а Google использует в качестве имени JsonObjectRequest, для этой специальной аббревиатуры принцип должен быть унифицирован.
метод
Имя метода должно быть в виде маленького верблюжьего регистра, первая буква строчная, а первая буква каждого последующего слова должна быть заглавной. В отличие от имен классов, имена методов обычно представляют собой глаголы или глагольные фразы, которые вместе с параметрами или именами параметров образуют глагольно-объектную фразу, то есть глагол + существительное. Хорошее имя функции, как правило, может напрямую знать, какую функцию функция выполняет через имя.
Методы, возвращающие истинные и ложные значения
Примечание: префикс, суффикс, суффикс, ало-самостоятельно используются отдельно.
способ проверить
Подход по запросу
Асинхронные связанные методы
метод обратного вызова
Методы манипулирования жизненным циклом объектов
Методы, связанные с операциями сбора
Методы, связанные с данными
глаголы, встречающиеся парами
Именование переменных и констант
именование переменных
Переменная — это величина, значение которой может быть изменено во время работы программы, включая переменные-члены и локальные переменные. Когда имя переменной состоит из нескольких слов, первая буква первого слова — строчная, а первая буква последующих слов — прописная, что обычно называется номенклатурой в верблюжьем регистре (также известной как номенклатура в верблюжьем регистре). переменные могут быть четко выражены, а название может отражать конкретное деловое значение.
Имена переменных не должны начинаться со знака подчеркивания или доллара, хотя синтаксически это разрешено. Имена переменных должны быть короткими и описательными. Имена переменных следует выбирать так, чтобы их было легко запомнить, то есть чтобы они указывали на их назначение. Старайтесь избегать односимвольных имен переменных, если только они не являются одноразовыми временными переменными. Не добавляйте is к логическим переменным в pojo (все логические поля в базе данных должны иметь префикс is_ ).
постоянное именование
постоянное именованиеCONSTANT_CASE, как правило, в верхнем регистре (кроме случаев, когда используется в качестве параметра метода) и отдельные слова с символами подчеркивания. Так что же такое константы?
Константы — это значения, которые остаются неизменными в рамках области видимости и обычно изменяются с помощью final. Обычно делятся на три типа, глобальные константы (public static finalукрашение), внутриклассовые константы (private static finalМодификация) и локальные константы (константы в методах или параметрах), локальные константы являются специальными, обычно именуемые в маленьком верблюжьем регистре.
Общее соглашение об именах
Старайтесь не использовать пиньинь, не смешивайте пиньинь и английский. Для некоторых общих выражений или тех, которые трудно описать на английском языке, можно использовать пиньинь.После использования пиньинь его нельзя смешивать с английским языком. Положительный пример:BeiJing,HangZhouПример счетчика:validateCanShu
- Старайтесь не использовать специальные символы в процессе именования, за исключением констант.
- попробуй не
jdkИли существующий класс во фреймворке имеет такое же имя, и его нельзя назвать с помощью ключевых слов в java. - Магическое использование предлогов, таких как for (можно заменить омофоном 4), to (можно заменить омофоном 2), from, with, of и т. д. Например, имя класса принимает User4RedisDO, имя метода — getUserInfoFromRedis, convertJson2Map и т. д.
комментарии к коду
Принципы аннотации
Хорошее наименование повышает читабельность кода, а именование кода часто имеет строгие ограничения. В отличие от аннотаций, программисты часто могут играть бесплатно, но это не значит, что они могут делать все, что захотят. Элегантные аннотации обычно удовлетворяют трем элементам.
Ничего странного Незакомментированный код очень недружелюбен к читателю.Даже если код написан для очистки, читатель будет как минимум психологически конфликтным.Кроме того,в коде часто много сложной логики,поэтому обязательно пишите аннотации не только для записи логики кода, но и для уточнения логики модификации.
Чем меньше, тем лучше С точки зрения обслуживания кода аннотации в коде должны быть сутью сути. Разумные и четкие имена могут сделать код легким для понимания.Для кода с простой логикой и соглашениями об именах, которые могут четко выражать функцию кода, аннотации не требуются. Злоупотребление аннотациями добавляет дополнительную нагрузку, не говоря уже о том, что по большей части это ерунда.
// 根据id获取信息【废话注解】getMessageById(id)
Заранее со временем аннотации должны меняться по мере изменения кода, а информация, выраженная аннотациями, должна быть точно такой же, как и в коде. Обычно аннотации должны быть изменены после изменения кода.
Формат аннотации
Аннотации можно условно разделить на два типа: аннотации javadoc и простые аннотации. Аннотации javadoc могут генерировать JavaAPI для обеспечения эффективной поддержки внешних пользователей. Аннотации javadoc обычно могут генерироваться автоматически при использовании IDEA или Eclipse и других инструментов разработки, а также поддерживать пользовательские шаблоны аннотаций, нужно только объяснить соответствующие поля. Студенты, участвующие в разработке одного и того же проекта, должны попытаться установить один и тот же шаблон аннотации.
Аннотация пакета
Аннотации пакетов часто имеют особое значение в работе. С помощью аннотаций пакетов вы можете быстро узнать, для каких функций используется код в текущем пакете. Настоятельно рекомендуется добавлять их в свою работу, особенно для некоторых более сложных пакетов. Аннотации пакетов обычно в корневом каталоге пакета.Ниже имя унифицировано как package-info.java.
/**
* 落地也质量检测
* 1. 用来解决什么问题
* 对广告主投放的广告落地页进行性能检测，模拟不同的系统，如Android，IOS等; 模拟不同的网络：2G，3G，4G，wifi等
* 2. 如何实现
* 基于chrome浏览器，用chromedriver驱动浏览器，设置对应的网络，OS参数，获取到浏览器返回结果。
* 注意：网络环境配置信息{@link cn.mycookies.landingpagecheck.meta.NetWorkSpeedEnum}目前使用是常规速度，可以根据实际情况进行调整
* @author cruder
* @time 2019/12/7 20:3 下午
*/
package cn.mycookies.landingpagecheck;
аннотация класса
В аннотациях javadoc каждый класс должен иметь аннотации.
аннотация свойства
Перед каждым атрибутом надо добавить аннотацию атрибута.Обычно бывает две формы.Насчет того, как выбрать, вы довольны, но это должно быть унифицировано в проекте.
аннотация метода
Перед каждым методом необходимо добавить аннотацию метода, а также объяснить каждый параметр в методе и возвращаемое значение.
Аннотация конструктора
Перед каждым конструктором необходимо добавить аннотацию. Шаблон аннотации выглядит следующим образом:
Меры предосторожности
Простые аннотации часто требуют инженерных определений байтов.При использовании аннотаций следует обратить внимание на следующие моменты:
Каждое значение атрибута класса перечисления должно быть аннотировано. Перечисление можно понимать как константу, которая обычно не изменяется. На него обычно ссылаются в нескольких местах. Изменение и добавление атрибутов в перечисление обычно приводит к большим последствиям. Влияние.
Сохраняйте типографику чистой и не используйте комментарии в конце строки; используйте 1 пробел после двойных косых черт и звездочек.
Писать не легко.Если статья вам помогла, можете оставить след и поставить лайк~