Java — различия между версиями

Материал из SEWiki
Перейти к: навигация, поиск
(Javadoc)
Строка 24: Строка 24:
  
 
=== Javadoc ===
 
=== Javadoc ===
Ко всем классам, интерфейсам и public/protected полям и методам должен быть написан <b>осмысленный<b> javadoc на грамотном английском языке.  
+
Ко всем классам, интерфейсам и public/protected полям и методам должен быть написан <b>осмысленный</b> javadoc на грамотном английском языке.  
  
 
Javadoc должен быть валидным (в частности, содержать все required тэги). Настоятельно рекоммендуется использовать консольные или встроенные в IDE средства проверки валидности javadoc. О том как писать javadoc.
 
Javadoc должен быть валидным (в частности, содержать все required тэги). Настоятельно рекоммендуется использовать консольные или встроенные в IDE средства проверки валидности javadoc. О том как писать javadoc.

Версия 23:59, 8 февраля 2012

Домашние задания

Первое задание срок сдачи: 15 февраля

Присылать задачи нужно на почту sergeynurk@gmail.com<b> с темой: <b>Java homework <фамилия> tasks 1,2,3...<b>

Задания должны находиться в jar архивах. В архивы включаются <b>только ваши исходники (.java файлы).

Для создания архивов используйте утилиту jar.

Каждая задача должна находиться в пакете ru.spbau.<ваша фамилия>.task<# задания>

Можете складывать несколько заданий в один архив.

Рекомендуемая литература

  • "Thinking in Java", Bruce Eckel
  • "Effective Java", Joshua Bloch

Coding conventions

В отличие от C++, для Java есть общепринятые coding conventions от компании Sun.

В первую очередь обратите внимание на Naming Conventions. Настоятельно рекоммендуется отдавать предпочтение длинным мнемоническим идентификаторам.

Некоторые требования к коду

Javadoc

Ко всем классам, интерфейсам и public/protected полям и методам должен быть написан осмысленный javadoc на грамотном английском языке.

Javadoc должен быть валидным (в частности, содержать все required тэги). Настоятельно рекоммендуется использовать консольные или встроенные в IDE средства проверки валидности javadoc. О том как писать javadoc.

Пример хорошего javadoc-а можно найти в любом классе стандартной библиотеки

Exceptions

При проверке ваших решений большое внимание будет уделяться тому как вы работаете с исключениями.

Распространенные недочеты:

  • Оборачивание проверяемых исключений в непроверяемые
  • Пустые catch блоки
  • Отсутствие вывода читаемой<b> полезной информации в catch блоках
  • Некорректное освобождение используемых ресурсов (в частности, открытых ранее файлов)

== Полезные ссылки ==