| Статистика |
Онлайн всего: 1 Гостей: 1 Пользователей: 0 |
|
Главная » 2016 » Сентябрь » 30
JSDoc — генератор документации в HTML-формате из комментариев исходного кода на JavaScript. Синтаксис JSDoc похож на синтаксис Javadoc, который используется для документирования Java кода, но предназначен для работы с языком JavaScript, который является более динамичным, и поэтому JSDoc не совместим с Javadoc. Как и Javadoc, JSDoc позволяет программисту создавать доклеты и теги, которые могут быть выведены в файл, например HTML или RTF. Пример Пример использования JSDoc.
/**
* Создает экземпляр Circle.
*
* @constructor
* @this {Circle}
* @param {number} r - Радиус окружности.
*/
function Circle® {
/** @private */
this.radius = r;
/** @private */
this.circumference = 2 * Math.PI * r;
}
/**
* Создает новый экземпляр Circle по диаметру.
...
Читать дальше »
|
Javadoc — генератор документации в HTML-формате из комментариев исходного кода на Java от Sun Microsystems. Javadoc — стандарт для документирования классов Java. Большинство сред разработки программного обеспечения автоматически генерируют HTML-документацию, используя Javadoc.
Javadoc также предоставляет API для создания доклетов и тэглетов, которые позволяют программисту анализировать структуру Java-приложения.
Применение
Комментарии документации применяют для:
документирования классов,
интерфейсов,
полей (переменных),
конструкторов,
методов,
пакетов.
В каждом случае комментарий должен находиться перед документируемым элементом.
Для документирования переменной можно использовать следующие дескрипторы: @see, @serial, @serialField, {@value}, @deprecated. Для классов
...
Читать дальше »
|
GraphML — язык описания (иногда упоминается как отдельный формат файлов) графов на основе XML.
Введение в GraphML
Ниже представлен пример простого ненаправленного графа с двумя узлами и одним ребром, их соединяющим:
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://graphml.graphdrawing.org/xmlns/1.0/graphml.xsd">
Другие механизмы описания графов
DOT (язык)
Trivial Graph Format — простой текстовый формат
GXL — формат обмена графами на основе XML (Официальный сайт)
...
Читать дальше »
|
Haml (HTML abstraction markup language) — язык разметки для упрощённой генерации HTML. HAML компилируется в HTML.
Эквивалент Haml для CSS — это LESS или Sass.
Пример
!!!
%html{ html_attrs('ru') }
%head
%title Мой блог
%meta(http-equiv="Content-Type" content="text/html; charset=utf-8")
= stylesheet_link_tag "main"
%body
#header
%h1 Мой блог
%h2 Записи
#content
- @entries.each do |entry|
.entry
%h3.title= entry.title
%p.date= entry.posted.strftime("%A, %B %d, %Y")
%p.body= entry.body
#footer
%p.copyright
Все права защищены © Иван
Результат выполнения предыдущего кода
...
Читать дальше »
|
|
|
|
|
