Соглашения по оформлению кода Java

12 сентября 1997

***

Информация об авторских правах

(c) 1997, Sun Microsystems, Inc. Все права защищены.

2550 Garcia Avenue, Mountain View, California 94043-1100 U.S.A.

Этот документ защищен авторским правом. Никакая часть этого документа не может быть воспроизведена ни в какой форме, никаким способом без письменного разрешения Sun и ее лицензиаров, если таковые имеются.

Информация, описанная в этом документе, может быть защищена одним или несколькими патентами США, иностранными патентами или приложениями, находящимися на стадии разработки.

ТОРГОВЫЕ МАРКИ

Sun, Sun Microsystems, Sun Microelectronics, логотип Sun, SunXTL, JavaSoft, JavaOS, логотип JavaSoft, Java, HotJava Views, HotJJavaChips, picoJava, microJava, UltraJava, JDBC, логотип Java Cup и Steam, "Write Once, Run Anywhere" и Solaris являются торговыми марками или зарегистрированными торговыми марками Sun Microsystems, Inc. в Соединенных Штатах и других странах.

UNIX ® является зарегистрированным товарным знаком в США и других странах, лицензируемой исключительно через X/Open Company, Ltd.

Adobe ® является зарегистрированной торговой маркой компании Adobe Systems, Inc.

Netscape Navigator™ является торговой маркой компании Netscape Communications Corporation.

Все остальные названия продуктов, упомянутые здесь, являются торговыми марками соответствующих владельцев.

ЭТОТ ДОКУМЕНТ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ» БЕЗ ГАРАНТИЙ ЛЮБОГО РОДА, ЯВНЫХ ИЛИ НЕЯВНЫХ, В ТОМ ЧИСЛЕ, ПРЕДПОЛАГАЕМЫХ ГАРАНТИЙ ТОВАРНОГО СОСТОЯНИЯ, ПРИГОДНОСТИ ДЛЯ КОНКРЕТНОЙ ЦЕЛИ ИЛИ НЕНАРУШЕНИЯ ПРАВИЛ.

ЭТОТ ДОКУМЕНТ МОЖЕТ СОДЕРЖАТЬ ТЕХНИЧЕСКИЕ НЕТОЧНОСТИ ИЛИ ТИПОГРАФСКИЕ ОШИБКИ. ПРИВЕДЕННАЯ ЗДЕСЬ ИНФОРМАЦИЯ ПЕРИОДИЧЕСКИ ОБНОВЛЯЕТСЯ; ЭТИ ИЗМЕНЕНИЯ БУДУТ ВНЕСЕНЫ В СЛЕДУЮЩИЕ РЕДАКЦИИ ДОКУМЕНТА. SUN MICROSYSTEMS, INC. МОЖЕТ ДЕЛАТЬ ИСПРАВЛЕНИЯ И/ИЛИ ИЗМЕНЕНИЯ В ПРОДУКТЕ(АХ) И/ИЛИ ПРОГРАММЕ(АХ), ОПИСАННЫХ В ЭТОМ ДОКУМЕНТЕ, В ЛЮБОЕ ВРЕМЯ.

Please Recycle

***

1 Введение

1.1 Зачем нужны соглашения по оформлению кода

1.2 Благодарности

2 Имена файлов

2.1 Расширения файлов

2.2 Общие имена файлов

3 Организация файла

3.1 Файлы исходного кода Java

3.1.1 Начальные комментарии

3.1.2 Операторы package и import

3.1.3 Объявление классов и интерфейсов

4 Отступы

4.1 Длина строк

4.2 Перенос строк

5 Комментарии

5.1 Форматы комментариев

5.1.1 Блочные комментарии

5.1.2 Однострочные комментарии

5.1.3 Прицепные комментарии

5.1.4 Комментарии до конца строки

5.2 Комментарии для документирования

6 Объявления

6.1 Количество объявлений в строке

6.2 Размещение

6.3 Инициализация

6.4 Объявление классов и интерфейсов

7 Операторы

7.1 Простые операторы

7.2 Составные операторы

7.3 Оператор return

7.4 Операторы if, if-else, if-else-if-else

7.5 Оператор for

7.6 Оператор while

7.7 Оператор do-while

7.8 Оператор switch

7.9 Оператор try-catch

8 Пробелы

8.1 Пустые строки

8.2 Расстановка пробелов

9 Соглашение об именовании

10. Приёмы программирования

10.1 Доступ к переменным класса и экземпляра

10.2 Обращение к переменным и методам класса

10.3 Константы

10.4 Присваивание значений переменным

10.5 Различные приёмы программирования

10.5.1 Скобки

10.5.2 Возвращаемые значения

10.5.3 Выражения перед "?" в условном операторе

10.5.4 Специальные комментарии

11 Примеры кода

11.1 Пример файла исходного кода Java

***

Соглашения по оформлению кода Java

1 Введение

1.1 Зачем нужны соглашения по оформлению кода

Соглашения по оформлению кода имеют важное значение для программистов по нескольким причинам:

* 80% от стоимости программного обеспечения приходится на его обслуживание.

* Вряд ли какое-либо программное обеспечение поддерживается в течение всей своей жизни одним автором.

* Соглашения по оформлению кода улучшают читабельность программы, позволяя разработчикам намного быстрее и тщательнее понять новый код.

* Если вы предоставляете свой исходный код как готовую программу, вы должны его хорошо запаковать и очистить, как и остальные программы, которые создаёте.

1.2 Благодарности

Этот документ отражает стандарты языка Java, представленные в Java Language Specification, от Sun Microsystems. Основной вклад внесли Питер Кинг, Патрик Ноутон, Майк Демани, Джонни Канерва, Кэти Уолрат и Скот Хоммель.

По вопросам адаптации, модификации или распространение этого документа, пожалуйста, прочтите наше уведомление об авторских правах на http://java.sun.com/docs/codeconv/html/Copyright.doc.html.

Комментарии к этому документу должны быть отправлены нам на форму обратной связи http://java.sun.com/docs/forms/sendusmail.html.

2 Имена файлов

В этом разделе приведены часто используемые имена и расширения файлов

2.1 Расширения имен файлов

Java-программы используют следующие расширения файлов:

Тип файла | Расширение имени файла

-----------------------

Исходник Java|.java

Байт-код Java|.class

2.2 Общие имена файлов

Часто используемые имена файлов включают в себя:

Имя файла | Применение

-----------------------

GNUmakefile | Зарезервированное имя для make-файлов. Мы используем gnumake для сборки нашего программного обеспечения.

README | Зарезервированное имя для текстового файла, содержащего информацию о других файлах в том же каталоге

3 Организация файла

Файл состоит из разделов, которые должны быть разделены пустыми строками и необязательным комментарием, идентифицирующий каждый раздел.

Файлы, в которых больше, чем 2000 строк являются громоздкими и их следует избегать.

Пример правильной организации Java программы см. в разделе "Пример файла исходного кода Java" на стр. 19.

3.1 Файлы исходного кода Java

Каждый файл исходного кода Java содержит один класс с ключевым словом public или интерфейс. Если есть классы с ключевым словом private и интерфейсы, связанные с public классом, то их можно разместить в том же самом исходном файле. Public класс должен быть первым классом или интерфейсом в файле.

Элементы исходного файла Java располагаются в следующем порядке:

* Начальные комментарии (смотрите "Начальные комментарии" на стр. 4)

* Операторы package и import; например:

import java.applet.Applet;

import java.awt.*;

import java.net.*;

* Объявление классов и интерфейсов (смотрите "Объявление классов и интерфейсов" на странице 4)

3.1.1 Начальные комментарии

Все файлы исходного кода должны начинаться с комментариев в стиле языка С, где перечислены программист(ы), дата, уведомление об авторских правах, а также краткое описание целей программы. Например:

/*

*Имя класса

*

*Сведения о версии

*

*Уведомление об авторских правах

*/