Стандарты кодирования

Стандарты кодирования

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

У большинства программистов есть свой индивидуальный стиль кодирования. Мелкие детали: как они обрабатывают исключения, как комментируют код, в каких случаях возвращают null и так далее. В одних случаях эти различия не играют особой роли, в других могут привести к серьёзному несоответствию дизайна системы и трудно читаемому коду. Стандарты кодирования - идеальное решение этой проблемы, если они, конечно, регламентируют важные моменты.

Вот небольшая выдержка из наших стандартов кодирования:

• Вы можете нарушить любое из этих правил, но на то должна быть веская причина и это должно быть задокументировано.

• По умолчанию используйте стандарты кодирования Sun: http://iava.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

• Ни при каких обстоятельствах не перехватывайте исключения без сохранения полного стека вызовов программы (stack trace), либо повторной генерации исключения (rethrow). Допустимо использование log.debug(), только не потеряйте стек вызовов.

• Для устранения тесного связывания между классами применяйте внедрение зависимостей на основе сеттеров (Setter Based Injection) (разумеется, за исключением случаев, когда такое связывание просто необходимо).

• Избегайте аббревиатур. Общеизвестные аббревиатуры, такие как DAO, допустимы.

• Методы, которые возвращают коллекции или массивы, не должны возвращать null. Возвращайте пустые коллекции и массивы вместо null.

Поделитесь на страничке

Следующая глава >

Похожие главы из других книг:

Обеспечение кодирования данных

Из книги автора

Обеспечение кодирования данных PoPToP использует программу pppd, которая, в свою очередь, использует средства ядра. В частности, PoPToP требует, чтобы демон pppd поддерживал кодирование, a pppd требует, чтобы средства поддержки кодирования присутствовали в ядре Linux. Поэтому для


16.13.6 Метод кодирования Base64

Из книги автора

16.13.6 Метод кодирования Base64 Метод кодирования Base64 преобразует любой тип данных к большему в 3 раза количеству текстовых символов. Данные разделяются на части по три 8-разрядных, байта. Например:10001000 00110011 11110001Для преобразования эта последовательность сначала разделяется


1. Форматы кодирования файлов Интернет

Из книги автора

1. Форматы кодирования файлов Интернет Форматы файлов Интернет можно разделить на несколько групп. Во первых форматы передачи файлов по FTP, для чего очень давно была разработана схема uuencode/decode, замененная затем на xxencode/decode. В дальнейшем произошел отказ в пользу Base64 и MIME,


Секреты кодирования

Из книги автора

Секреты кодирования Окна Code (Окна программного кода) - это сердце редактора Visual Basic: в них вы создаете VBA-операторы, непосредственно выполняющие полезную работу. В этой главе я не собираюсь говорить об использовании VBA-операторов, сосредоточусь на том, как получить максимум


Стиль кодирования

Из книги автора

Стиль кодирования Константа для одного является переменной для другого. — Алан Перлис (Alan Perlis) В этом разделе мы перейдем от вопросов проектирования к вопросам, которые появляются в основном при реальном кодировании.Правила и рекомендации из этого раздела применимы


Особенности кодирования литеральных символов и пар расстояние/длина

Из книги автора

Особенности кодирования литеральных символов и пар расстояние/длина В предыдущих разделах ничего не было сказано о небольшом нюансе реализации алгоритма: как в процессе считывания сжатых данных отличить литеральный символ от кода расстояние/длина? В конце концов, не


Три способа кодирования звука

Из книги автора

Три способа кодирования звука Звук может быть закодирован в цифровой формат с использованием трех принципиально различных методов. (Они различаются так же, как покадровая и трансформационная анимация.) Давайте все о них разузнаем.Прямая оцифровкаПервый метод,


ТЕХНОЛОГИИ: h264. Год спустя: Технология кодирования видео в MPEG-4 AVC. Часть вторая

Из книги автора

ТЕХНОЛОГИИ: h264. Год спустя: Технология кодирования видео в MPEG-4 AVC. Часть вторая Автор: Филипп КазаковНадеюсь, в конце прошлого номера я вас достаточно заинтриговал. Итак, вы открыли исходный файл с видео в AviSynth Script Creator’e и — ничего нового там еще не появилось, так что можете


ТЕХНОЛОГИИ: h264 Год спустя Технология: Кодирования видео в MPEG-4 AVC. Часть первая

Из книги автора

ТЕХНОЛОГИИ: h264 Год спустя Технология: Кодирования видео в MPEG-4 AVC. Часть первая Автор: Филипп КазаковЧуть больше года назад на страницах «Компьютерры» я делился опытом работы с новаторским на тот момент видеокомпрессором Ateme h264, реализованном в программе-кодировщике Ahead Nero


Leadtek WinFast PxVC1100 — ускоритель кодирования видео Игорь Осколков

Из книги автора

Leadtek WinFast PxVC1100 — ускоритель кодирования видео Игорь Осколков Сердцем Leadtek WinFast PxVC1100 является чип Toshiba SpursEngine SE1000. Что это такое и с чем его едят?! Вообще-то, это не просто чип или процессор, а скорее SoC. SpursEngine базируется на архитектуре Cell Broadband Engine (или просто Cell), разработкой