Code documentation for Javascript and Actionscript 3

Prerequisites for Actionscript documentation

Prerequisites for Javascript documentation

Actionscript 3 Code Documentation

Example documentation:

/** * class-description */ class-declaration
Code language: PostgreSQL SQL dialect and PL/pgSQL (pgsql)
/** * method-description * * @see method-name * @param name description * @return description */ method-declaration.
Code language: JavaScript (javascript)
/** attribute-description */ attribute-declaration
Code language: PostgreSQL SQL dialect and PL/pgSQL (pgsql)

Extracting the documentation from the sourcecode:

asdoc.exe -source-path /source/directory -doc-sources /source/directory -output /output/directory -window-title "Project Title"
Code language: DOS .bat (dos)

Javascript Code Documentation

Example documentation:

/** * class-description * * @author author * @extends class-name * @see class-name * @version version * @constructor */ class-constructor-declaration.
Code language: JavaScript (javascript)
/** * method-description * * @see class-name#method-name * @param {data-type} name description * @return description * @type data-type-of-return */ method-declaration.
Code language: JavaScript (javascript)

Extracting the documentation from the sourcecode:

perl jsdoc.pl /source/directory --directory /output/directory --project-name "Project Title"
Code language: DOS .bat (dos)

References for this post

Leave a comment

Your email address will not be published. Required fields are marked *