Как разработчик, должны быть строгие спецификации кода. По этой причине я суммировал некоторые случаи спецификации кода.
Оглавление
1. Предисловие
2. Испытательный диапазон
3. спецификация именования Java-
3.1 Общественное соглашение
3.2 файлы Java, сумки, сумки
3.3 Класс, спецификации именования интерфейса
3.4 Спецификация именования метода
3.5 постоянный
3.6 переменные и параметры
3.7 компонент/компонент
3.8
3.9 Таинственное число
3.10 Другие
3.11 Java Exception
3.12 именование массива
3.13 Правила именования таблицы баз данных
3.14 Правила именования базы данных.
3.15 Имя файла JSP
3.16 Название сервлета
4. Спецификация формата письма
4.1 Endix
4.2 Пространство
4.3 Выравнивание
4.4 пустая линия
4.5 Примечание
5. Стиль файла кода
1. Предисловие, чтобы обеспечить читаемость программы источника системы, тем самым улучшая обслуживание системы и формулирует следующие спецификации программирования для регулирования программирования системы. Исходные программы в других ресурсах, унаследованных системой, также должны быть изменены соответствующим образом в соответствии с этой спецификацией.
2. Искрет этого документа будет использоваться в качестве формата программирования для разработки программного обеспечения Hebei Postal Application System (Java Language). Во время процесса кодирования, тестирования и технического обслуживания системы это должно быть строго наблюдать.
3. спецификация именования Java
3.1 Наименование имени исходного файла, метод, каталог, пакет, имя таблицы базы данных, поле базы данных и т. Д. В имени Имя исходного файла, метод, каталог, пакет, имя таблицы базы данных, имя таблицы базы данных, поле базы данных. Мрачный
Наименование, используемое системой, выражается в английских сокращениях. Мрачный
Метод именования: prefix+{Abbreviation word word}, префикс выражает использование именования, например, таблицы базы данных. Мрачный
Префикс именования определяется проектной командой. Мрачный
Другие объекты, кроме системы общего обслуживания, все именование использует строчные. Один путь использует «_» в качестве символа подключения, а другой - напрямую подключить первые буквы слова Prime. В этой спецификации имя базы данных и имя поля базы данных используют первый путь, а остальные находятся в втором месте. Мрачный
Использование может точно проиллюстрировать полный дескриптор английского языка переменной/Field/Class/Interface/Bag. Например, используя такие имена, как FirstName, ListAllusers или CorporateCustomer, строго запрещено использовать китайские и не связанные с ними слова, хотя Java поддерживает имена Nicode, эта спецификация предусматривает, что она не позволяет использовать китайские символы, такие как упаковка, классы, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, взаимодействие, интерфейсы, взаимодействия, взаимодействия, взаимодействия, взаимодействие, взаимодействия, взаимодействия, взаимодействия, взаимодействие, взаимодействие, взаимодействия, взаимодействия, взаимодействия. , методы, переменные, поля и т. Д. Названный
Использование строчного смешивания для улучшения читаемости имени. Как правило, следует использовать строчные буквы, но первые буквы имен и имен интерфейсов, и первая буква любого промежуточного слова должна быть введена на заглавную установку. Все имена пакетов. Мрачный
Постарайтесь использовать как мало сокращений, но если вы должны его использовать, когда вы используете общественные сокращения и привычные сокращения, такие как реализация, может быть сокращена, поскольку IMP, менеджеры (менеджер) могут быть сокращены как MGR и т. Д. злоупотребление злоупотреблением. （Избегайте использования длинных имен (предпочтительно не более 25 букв).
Избегайте использования чисел, но 2 можно использовать вместо, 4 вместо и т. Д., Такие, как: go2jsp.
3.2 Java File, сумка
Имя файла должно быть таким же, как и его класс, и первая буква слова заглавляется. Мрачный
Имя пакета обычно названо в честь проектов или модулей, и использует меньше сокращений и длинных имен. Мрачный
Основной пакет: com.czpost, все пакеты и файлы принадлежат этому пакету.
Имя пакета состоит из следующих правил: [базовый пакет].
Класс не должен быть определен непосредственно под основным пакетом.
3.3 Категория и спецификации именования интерфейса Все слова всех слов. Используйте слова, которые могут быть точно такими же, значение интерфейса, функция и т. Д. Обычно использует существительные. Мрачный
Интерфейс может принести префикс или способный, ible, e и другой суффикс.
3.4 Метод спецификации именования метода. Наименование метода стандарта именования должно использовать полные английские дескрипторы, смешанное использование строчных счетов: первые буквы всех промежуточных слов. Первое слово метода метода часто использует глагол с сильным цветом действия. Значение значения использует префикс GET, класс значений использует префикс SET, а использование класса суда (имеет) префикс. Пример: getName () setSarry () islogon () последовательность параметров метода: (оператором, рабочим контентом, эксплуатационным логотипом, др.) Пример: public void reply (String Sourcest, String Oldstr, String Newstr) {...... ...}
3.5 Константа использует полное английское слово из капитализации и подключается к строке между словами и словами, такими как: default_value
3.6 Переменные и переменные параметров рекомендуются для использования метода венгерских именования.
Переменная платформы (включая int, короткие, длинные): Начните с N, например: Long ncrednum;
Плавающие переменные (включая Float, Double): Начните с F, например: Double ftranamt;
Переменная символа: начните с C, например: char cpageflag;
Переменная дата: Начните с D, например: Date Dtoday;
Строковые переменные: начните с S, например: char spageno [2+1];
Глобальные переменные: тип данных с G, например: Chsbankno [10+1];
Статические переменные: Статические переменные также являются глобальными переменными в файлах, а правила именования такие же, как глобальные переменные. Мрачный
Система -Уровень Переменные: Система -Уровень переменные также являются глобальными переменными.
Например: char _sbankno [10+1] нет «G».
Временные переменные обычно называют I, J, K, M и N, и они обычно используются для целого числа;
3.7 Компоненты/компоненты должны принять полный компонент именования английского дескриптора (компонент интерфейса), за которыми следуют правила именования венгров, такие как: Btnok, lblName. Кнопка t -кнопка переменная btn+xxxxxxx, например: btnsave, btn exit, btnprint и т. Д.
3.8 Коллекция, такая как массив и вектор, должна быть названа несколькими числами, чтобы представлять тип объекта, хранящегося в очереди. Наименование должно использовать полный английский дескриптор. Такие как: Vector Vproduts = new Vector ();
3.9 Загадочные численные программы часто используют некоторые количества. Обратите внимание, что именование этой константы должно выражать значимость числа, и это должно быть все проникновение, что отличается от идентификатора, соответствующего переменной. Например, число 50 может быть определена как постоянная замена, называемая NUM_OF_EMPOLYEES.
3.10 Двойной дубл следует использовать, когда другие именование указывают на то, что они представляют несколько значений. Такие как: orderitems.
3.11 Аномальная аномальная категория Java состоит из слов, которые представляют ненормальный тип и исключение, такие как ActionXception.
Аномальные случаи, как правило, используют E, Ex и т. Д. Во множестве аномалий, используйте это ненормальное название или аббревиатура, чтобы добавить E, Ex и т. Д.
3.12 Массивы именования всегда должны быть названы следующим образом: Byte [] Buffer;
3.13 Правила именования таблицы баз данных разделены нижними линиями между префиксом и именованием.字 Назовите это состоит из строчной буквы. Мрачный
Если именовавшее слово состоит из одного слова, оно может быть использовано для полного написания; Между аббревиатурами используйте нижнюю линию. Например: 库 例 例 例: Начните с 't_' Просмотр: Начните с 'v_' 例 例 例 例 例 例: начало с 't_' и единственного индекса Библиотеки Таблица в конце '_idx': 'end
3.14 Правила именования базы данных
Если именовавшее слово состоит из одного слова, оно может быть использовано для полного написания; Между аббревиатурами используйте нижнюю линию.字 Назовите это состоит из строчной буквы. Нет префикса.
3.15 JSP именование файла использует полное описание английского языка, чтобы указать функцию, выполненную JSP, включая яркий глагол, первые буквы, такие как: viewmessage.jsp, edituser.jsp или forumschooser.jsp и т. Д.
3.16 Название класса сервлета обычно соответствует объектам, обслуживаемым в службе суффикса, такими как: пользовательский сервис, торговля и т. Д.
4. Формат написания строго требует, чтобы формат письма делал программу аккуратной, простым для чтения и единого стиля. Рекомендуется, чтобы исходная программа разработала инструмент Eclipse, а спецификации формата предварительно установлены в инструменте.
4.1 Предложения Innsy и вдавливания основаны на 4 пустых сетках. Записаны предварительные операторы, глобальные данные, заголовок, дополнительное описание, описание функции, этикетка и т. Д. «{» И «}» блока предложений выровнены и выровнены с предыдущей строкой. Метод по умолчанию в Sclipse - это начало "{" не отдельная строка, и рекомендуется перейти на вышеуказанный формат.
4.2. Можно использовать в принципе ключевых слов, например: if (...) и так далее. Требования к пространству оператора следующие: "::", "->", "[", "" "," ++ ","-"," ~ "," "!", "+"- «(Относится к положительному числу)», и »(цитируется) и другие операторы, такие как две стороны расчета, не без пробелов (из которых одноразовая система вычисления символов относится к подключенной стороне операции), другой Операторы (в том числе большинство двух операторов, операторов и операторов и операторов, а также «трехэкюрированного оператора»?: «Одна пустая сетка с обеих сторон может быть выровнена в соответствии с ситуацией, когда функция определена, но ее можно использовать, когда функция реализована. «Сетка не может быть пустой или много -пространством, когда вам нужно выровнять.
4.3. В принципе должны быть выровнены близкие линии выравнивания, а выравнивание включает все части, такие как типы, модификации, имена и параметры. Длина каждой строки не должна превышать экран слишком много. СДАКТАЦИЯ Первой строки, то есть, если ее следующая строка - «{», она должна быть выровнена с первой строкой. Определения переменных лучше всего подходить с добавлением пробелов или клавиш вкладок, а переменные одного типа лучше всего вместе. Как показано в следующем примере: int nvalue;
4.4 В пустой линии должны быть нерегулярные пустые линии, такие как десять последовательных пустых линий. Каждая часть структуры файла программы пуста. Для функций, которые вы пишете, рекомендуется добавить «// -------». По крайней мере, одна строка должна быть пустой между внутренними данными функции и кодом. этого. В классе есть по крайней мере одна строка между четырьмя «P», и данные и функции также должны быть пустыми.
4.5 Примечания - это конкретное осуществление читаемости программного обеспечения. Аннотация программ, как правило, составляют 20%от количества программного кодирования, а требования к программному обеспечению составляют не менее 20%. Программные аннотации не могут использоваться в абстрактных языках, таких как «обработка» и «цикл» в абстрактном языке. Избегайте комментариев из каждой строки процедур, вы можете добавить комментарий перед программой с четкой логикой обработки. Комментарии необходимы, но слишком много должно быть слишком много. Ниже приведены четыре необходимых примечания: Название и дополнительное описание.的 Объяснение функций, классов и т. Д. Должны быть соответствующие объяснения практически для каждой функции. При необходимости должны быть некоторые инструкции, такие как специальные требования к программному обеспечению и аппаратному обеспечению. Заявление об общественных функциях и общественных классах должно быть объяснено методом и дизайнерскими идеями. Мрачный
Должно быть определенное объяснение в неясном или непревзойденном. Мрачный
И небольшое количество других заметок, таких как комментарии пользовательских переменных, время написания кода и т. Д.
5. Стиль файла кода все файлы Java (*. Java) должны следовать следующим правилам стиля:
Для генерации файлов для стандартизированного класса производной Java попробуйте использовать инструмент Eclipse для генерации формата файла, чтобы избежать ручных файлов/реализации ручных заголовок. E -пакет/Import Package Line должен быть перед строкой импорта, стандартное имя пакета в импорте находится перед именем локального пакета и расположено в порядке букв. Если строка импорта содержит различные суб -ректорию в одном и том же пакете, ее следует обрабатывать с*.
Пакет Hotlava.net.stats; Мрачный
В основном аннотации головного файла файла в основном показана некоторая информация файла, которая является общим описанием программы, которая может улучшить читабельность и обслуживание программы. Аннотация головы файла, как правило, стоит за оператором пакета/импорта, и описание класса. Требуется написать хотя бы имена файлов, создателей, время создания и описания контента. Формат должен быть ограничен как можно больше: /*** Название: ОК, чтобы определить класс позиции мыши* Описание: определить, какое поле работы сейчас и возвращает номер задания* @copyright: Copyright (C) 2002* @company: Hit * @authoror: Rivershan * @version: 1.0 */ Класс Следующий - это комментарии класса, которые обычно используются для объяснения класса. / ** * Класс, подавляющий набор пакетов и байтов, еместный Расширение и реализует общественный класс Counterset расширяет наблюдаемые орудия клонируемых Классовые поля
Далее является переменная члена: / ** * Количество пакетов * / Защищенные пакеты; Если переменные участника, определяемые Procisty, Private и Package, ясны, комментария нет.是 Метод доступа - это способ получить доступ к переменной. Просто просто использовать переменные класса, чтобы получить значение, которое можно просто записано на строке. (Лично думайте, что пытайтесь написать как можно больше)
/** * Получите счетчики * @return Array, содержащий статистические данные.
Public int [] getPackets () {return copyRary (packets, offset);} public int [] getBytes () {return copyArray (bytes, Office)] getPackets () {return Packets;} public void setPackets (int [] Packets) {This.packets = packets;}Другие методы не должны быть записаны на строке конструктора. Типы доступа («public», «private» и т. Д., И любая «статическая», «окончательный» или «синхронизированный» должен быть в одной строке, а методы и параметры могут быть записаны один за другим. Это может создавать методы и параметры легче читать.
public Centresterset (int size) {
this.size = size;
}
Если метод клона может быть клонирован, следующим шагом является метод клона: Public Object Clone () {)
пытаться {
Count object obj = (Crownset) super.clone ();
} Catch (clonenotsupportedException e) {{{
Бросить новый интернет («Неожиданный клоненотсупортейкция:» + e.getMessage ());
}
}
Метод класса начал писать метод класса:
/ ** * Установите количество пакетов * GalargumentExcation {
// Убедитесь, что массивы одинакового размера // if (r1.length! Размер новостей »; System.Arraycopy (R1, 0, R3, 0, R1.Length); System.ArrayCopy (R2, 0, R4, R4, R1.Length); один класс должен определить метод ToString:
public String toString () {string retval = "crownset:"; ();} Return retval;}Если основной метод определен, его следует записано в нижней части класса.