Документирование кода
Рассмотрим документирование кода. Мы изучим технологию создания документации с помощью утилиты javadoc. В листинге 5.5 представлен пример простого документирования кода.
Листинг 5.5.
Пример документирования кода
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
/** * Created by vitaly on 29.05.2016. */ public class Fruits { /** Свойство - цвет */ String color; /** Свойство - имя */ String name; /** Создает новый объект без задания значения свойства color */ public Fruits() { } public Fruits(String name) { this.name = name; } /** Создает объект с заданием ему всех свойств */ public Fruits(String name, String color) { this.name = name; this.color = color; } /** Задает значение свойства name */ public void setName(String name) { this.name = name; } /** Получает значение свойства name */ public String getName() { return name; } /** Задает значение свойства color */ public void setColor(String color) { this.color = color; } /** Получает значение свойства color */ public String getColor() { return color; } /** Главный метод программы. Создает 3 объекта: apple, orange и lemon и устанавливает для них значения свойств, а затем выводит на экран */ public static void main(String[] args) { Fruits apple = new Fruits(); apple.setName("Apple"); apple.setColor("Red"); Fruits orange = new Fruits("Orange"); orange.setColor("Orange"); Fruits lemon = new Fruits("Lemon", "Yellow"); System.out.println("Значение объекта apple:\nname = " + apple.name + "\ncolor = " + apple.color + "\n"); System.out.println("Значение объекта orange:\nname = " + orange.name + "\ncolor = " + orange.color + "\n"); System.out.println("Значение объекта lemon:\nname = " + lemon.name + "\ncolor = " + lemon.color + "\n"); } } |
В комментариях нужно использовать теги, иначе javadoc откажется правильно работать. Они предназначены для специфического отображения текста. Все теги начинаются с символа @.
Давайте рассмотрим некоторые из них.
Приведем пример уже созданной программы с документированием кода с помощью тегов (листинг 5.6).
Листинг 5.6.
Пример программы с документированием кода с помощью тегов
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
/** Класс служит для хранения объектов-фруктов со свойствами <b>name</b> и <b>color</b> @author vitaly @version 1.0 */ public class Fruits { /** Свойство - цвет */ String color; /** Свойство - имя */ String name; /** Создает новый объект @see Fruits#Fruits(String) @see Fruits#Fruits(String, String) */ public Fruits() { } /** Создает новый объект @param name Имя фрукта @see Fruits#Fruits() @see Fruits#Fruits(String, String) */ public Fruits(String name) { this.name = name; } /** Создает новый объект @param name Имя фрукта @param color Цвет фрукта @see Fruits#Fruits() @see Fruits#Fruits(String) */ public Fruits(String name, String color) { this.name = name; this.color = color; } /** Задает значение свойства name, которое можно получить при помощи метода {@link #getName()} @param name Новое значение свойства name */ public void setName(String name) { this.name = name; } /** Получает значение свойства name, которое можно задать с помощью метода {@link #setName(String)} @return Значение свойства name */ public String getName() { return name; } /** Задает значение свойства color, которое можно получить при помощи метода {@link #getColor()} @param color Новое значение свойства color */ public void setColor(String color) { this.color = color; } /** Получает значение свойства color, которое можно задать с помощью метода {@link #setColor(String)} @return Значение свойства color */ public String getColor() { return color; } /** Главный метод программы. Создает 3 объекта: apple, orange и lemon и устанавливает для них значения свойств, а затем выводит на экран @params args Параметры командной строки */ public static void main(String[] args) { Fruits apple = new Fruits(); apple.setName("Apple"); apple.setColor("Red"); Fruits orange = new Fruits("Orange"); orange.setColor("Orange"); Fruits lemon = new Fruits("Lemon", "Yellow"); System.out.println("Значение объекта apple:\nname = " + apple.name + "\ncolor = " + apple.color + "\n"); System.out.println("Значение объекта orange:\nname = " + orange.name + "\ncolor = " + orange.color + "\n"); System.out.println("Значение объекта lemon:\nname = " + lemon.name + "\ncolor = " + lemon.color + "\n"); } } |
Зачем это нужно?
Для документирования кода
Для новичка абсолютно непонятная статья. Пришлось искать информацию в других источниках.
похоже Runnable и Thread одинаковы, или только я вижу их такими? как исправите, удалите мой комментарий
спасибо, исправили и вывели в отдельный урок http://www.fandroid.info/chto-takoe-mnogopotochnost-rabota-s-potokami-v-java/