Coding Standards Documentation

Coding Standards Index edit
Introduction Overview Documentation	Variables Menus AJAX Calls

All projects need documentation and BOARD18 is no exception.
I have been trying to keep up with this need while developing BOARD18.
This page is intended to standardize the documentation (comments) that is actually in the code.

Called Programs

Most of the server side processing for BOARD18 is done in stand alone PHP programs that are executed from the web pages via AJAX calls.
The files that contain these programs should all begin with a block of comments with the following format.

• A paragraph explaining the function of the program.
• A description of all of the input parameters to this program.
• A description of the output produced by this program.

This page is a stub.

The BOARD18 Project will soon be expanding it.