Правила именования классов, интерфейсов, переменных (полей), и констант:
Именование переменных, классов, интерфейсов и констант должно производится в соответствии со следующим правилам:
Все имена за (исключением имен вспомогательных переменных) должны максимально четко отображать смысл переменной, класса, интерфейса или константы. Не допускается именование транслитерацией (русские слова английскими буквами), все имена должны быть английскими.
Имя переменной начинается с символов в нижнем регистре, имена классов и интерфейсов – с символа в верхнем регистре.
Если имя переменной состоит более чем одного слова, образующие слова связываются между собой без пробела, каждое слово, следующее после первого, начинается с символа в верхнем регистре.
Использование символа подчеркивания для разделения слов в имени допустимо, но предпочтительней использовать его только в именах констант. Имена констант образуются из слов в верхнем регистре, связанных символом подчеркивания.
Примеры имен переменных:
currentUser
itemCounter
Примеры имен классов:
BufferedReader
ConsistencyCheacker
ExternalUser
Примеры имен констант:
MAX_ITEMS_NUMBER
TIMER_DELAY
Правила именования методов близки к правилам именования переменных:
Имена всех методов класса должны максимально четко отображать смысл действий, производимых этим методом. Первое слово, образующее имя метода, по возможности должно быть глаголом, описывающим действие.
Имя каждого метода должно начинаться со слова в нижнем регистре
Если имя метода образуется более чем из одного слова, то образующие слова связываются между собой без пробела, и каждое слово, следующее после первого, начинается с символа в верхнем регистре.
Примеры имен методов:
close
checkUserRigths
readNextLine
getProperty
setProperty
Правила комментирования кода:
Документированию с использованием специальных комментариев (для дальнейшего использования утилиты javadoc) в обязательном порядке подлежат все пакеты, классы, входящие в состав пакета, основные поля класса, а так же все входящие в класс методы.
Комментарии должны включать в себя:
краткое описание класса или метода
описание отдельных параметров метода
В случае использования среды Together для создания диаграммы классов необходимо выбрать эту диаграмму в соответствующем меню (рис. 8).
Рис. 8. Окно выбора разрабатываемой диаграммы.
Затем приступить к построению диаграммы классов, используя соответствующую панель (рис. 9).
Рис. 9. Внешний вид специальной панели инструментов для диаграммы классов
Результатом выполнения этого этапа должна быть, сформированная диаграмма классов, документация (сгенерированную javadoc), сгенерированные шаблоны классов (исходный код).
Этап №3.
Разработать диаграммы деятельности для моделирования процесса выполнения различных операций при этом должна отображается логика или последовательность перехода от одной деятельности к другой. Таких диаграмм необходимо разработать не менее 4.
В диаграммах должны быть реализованы переходы, ветвления, разделение и слияние параллельных потоков. В случае если проектируемая система отражает работу нескольких подразделений (как правило), то требуется использовать специальные конструкции, называемые дорожки “swimlane”.
В случае использования среды Together для создания диаграммы деятельности необходимо выбрать эту диаграмму в соответствующем меню (рис.10).
Рис. 10. Окно выбора разрабатываемой диаграммы.
Затем приступить к построению диаграммы деятельности, используя соответствующую панель (рис. 11).
Рис. 11. Внешний вид специальной панели инструментов для диаграммы деятельности
Результатом выполнения этого этапа должны быть сформированные диаграммы деятельности, описание этих диаграмм.
Этап №4.
Разработать диаграммы последовательности, отражающие различные аспекты функционального описания системы. Выбрать несколько функций системы, определенных в диаграмме вариантов использования и реализовать для них соответствующие диаграммы последовательности. Таких диаграмм последовательностей необходимо разработать не менее 4. Количество объектов, участвующих в таких последовательностях должно быть от 3 до 4. Таким образом, как минимум в одной из диаграмм должно участвовать не менее 4 объектов.
В случае использования среды Together для создания диаграммы последовательности необходимо выбрать эту диаграмму в соответствующем меню (рис. 12).
Рис. 12. Окно выбора разрабатываемой диаграммы.
Затем приступить к построению диаграммы последовательности, используя соответствующую панель (рис. 13).
Рис. 13. Внешний вид специальной панели инструментов для диаграммы деятельности.
Результатом выполнения этого этапа должны быть, разработанные диаграммы последовательности, описание этих диаграмм.
Задание на курсовую работу.
Тема: Разработка проекта информационной системы с помощью унифицированного языка моделирования UML.
Задание: Название проектируемой информационной системы должно совпадать с темой выбранной на этапе №1. Выполнение курсовой работы проходит в два этапа:
Этап первичного проектирования. Составление технического задания на проектируемую информационную систему. Составление диаграммы вариантов использования, диаграммы классов, диаграммы деятельности и диаграммы последовательности (этапы №1-4).
Этап реализации. На данном этапе необходимо реализовать некоторые функции системы, отраженные в диаграммах последовательности. Таким образом, в ходе выполнения данного этапа необходимо будет реализовать ряд методов, принимающих участие в выбранной диаграмме последовательности. Таких методов должно быть не менее 6 и принадлежать они должны не менее 3 различным классам. Выбранную для реализации диаграмму последовательности согласовать с преподавателем при сдаче лабораторной работы №4. Если потребуется, то по результатам реализации провести корректировку диаграммы последовательности.
Отчет по курсовой работе должен содержать следующие главы:
1. Введение.
2. Техническое задание.
3. Разработка диаграммы вариантов использования.
4. Разработка диаграммы классов.
5. Разработка диаграммы деятельности.
6. Разработка диаграммы последовательности.
7. Реализация методов.
8. Корректировка проекта.
9. Выводы.
10. Приложения.
В приложении приводится листинг разработанного программного продукта.