Changes

Jump to navigation Jump to search
649 bytes added ,  23:11, 30 May 2013
no edit summary
=Introduction=
[http://xqdoc.org xqDoc] provides a simple vendor neutral solution for generating a documentation from XQuery modules. The documentation conventions have been inspired from Java’s by the JavaDoc standard. Documentation comments begin with {{Code|(:~}} and end with {{Code|:)}}, and tags start with {{Code|@}}.xqDoc comments can be specified for main and library modules, variable declarations and function declarations, as shown in the following example: <pre class="brush:xquery">(:~ : This module provides some sample functions. : : @author John Clash : @version 1.0 :)module namespace samples = 'http://basex.org/modules/samples'; (:~ This is a sample number. :)declare variable $samples:number := 1; (:~ : This function simply returns the specified number. : @param $number number to return : @return specified number :)declare function samples:same($number as xs:integer) as xs:integer { $number}; </pre>
=Conventions=
Bureaucrats, editor, reviewer, Administrators
12,957

edits

Navigation menu