Esempio di output DocBox

Esempio di output DocBox

Un esempio reale di ciò che produce bxSites docbox. Ogni pagina qui sotto proviene da un'esecuzione vera sul codice mostrato: niente è un'illustrazione scritta a mano.

Data questa classe nella cartella models/ di un progetto:

/**
 * A single book on the shelf, immutable once created.
 *
 * @author Ortus Solutions
 */
class singleton accessors=true {

	/**
	 * The book's title
	 */
	property name="title" type="string";

	/**
	 * Where book records are read from
	 */
	property name="datasource" type="string" inject="coldbox:setting:bookDatasource";

	/**
	 * Build a book.
	 *
	 * @title The book's title
	 * @author The book's author
	 */
	function init( required string title, string author = "Unknown" ) {
		return this
	}

	/**
	 * Return a copy of this book with a new title.
	 *
	 * @newTitle The replacement title
	 *
	 * @return a copy carrying the new title
	 */
	Book function withTitle( required string newTitle ) {}

	private function normalize() {}
}

...bxSites docbox scrive api/docbox/models/Book.md con questo frontmatter:

---
title: "Book"
summary: "A single book on the shelf, immutable once created."
tags: [api, docbox]
---

E questo corpo, riprodotto qui sotto non come blocco di codice ma renderizzato davvero: è il corpo reale della pagina generata, dal vivo, barra di filtro compresa. Prova il chip Private, o digita "title" nella casella di ricerca:

Book

models.Book · Class

A single book on the shelf, immutable once created.

Annotations

• @accessors true
• @singleton

Properties

Cosa notare

• Che la tabella delle proprietà esista. La strategia JSON di DocBox scarta i blocchi property dichiarati; bx-sites li rilegge dagli stessi metadati di classe usati da DocBox, ed è per questo che title e datasource compaiono qui con le loro descrizioni, e che l'inject di WireBox su datasource sopravvive.
• Anche il testo di @return sopravvive, per lo stesso motivo: vedi la riga Returns sotto withTitle.
• I metodi privati sono inclusi, a differenza del generatore Javadoc. DocBox li riporta, quindi vengono documentati, e il chip Private li nasconde quando non servono.
• init è il costruttore, con una sezione propria prima dei metodi.

Vedi Riferimento API con DocBox per la configurazione e Esempio di output ColdBox per ciò che il verbo ColdBox produce dallo stesso progetto.