Интернет магазин китайских планшетных компьютеров



Компьютеры - Javadoc - Пример

01 мая 2011


Оглавление:
1. Javadoc
2. Пример



Пример использования разметки Javadoc для документирования метода . Типы переменных указывать не нужно.

 /**
  * Проверяет, допустимый ли ход.
  * Например, чтобы задать ход e2-e4, напишите isValidMove;
  * @author John Doe
  * @param theFromFile Вертикаль, на которой находится фигура
  * @param theFromRank Горизонталь, на которой находится фигура
  * @param theToFile   Вертикаль клетки, на которую выполняется ход
  * @param theToRank   Горизонталь клетки, на которую выполняется ход
  * @return true, если ход допустим, и false, если недопустим
  */
  boolean isValidMove
  {
      . . .
  }


Просмотров: 2359


<<< JavaFX