Comments

Always you should write comments. Each comment should has the following entries.

# Descriptions: 
#    Arguments: $self $args
# Side Effects: 
# Return Value: none
If in C language,
// Descriptions: 
//    Arguments: $self $args
// Side Effects: 
// Return Value: none
or
/*
 * Descriptions: 
 *    Arguments: $self $args 
 * Side Effects: 
 * Return Value: none
 */

If you use perl, please write POD in addition to the comment described above.

Comment: Arguments

We use the following terms in comment. For example,

OBJ($curproc)
STR($buf)

TERM   What ?              perl internal
----------------------------------------------------------
OBJ    object              (blessed variable)
STR    string              (PV (SV special case))
NUM    number              (SV)
ARRAY  array               (AV)
HASH   hash                (HV)
HANDLE file handle         (GV)
append _REF to reference variables.
ARRAY_REF
HASH_REF

my homepage is www.fml.org/home/fukachan/.
my free softwares are found at www.fml.org/software/.
fml 4.0 project homepage is www.fml.org/fml/menu.ja.html.
fml 8.0 (fml-devel) project homepage is www.fml.org/software/fml8/.
about one floppy bsd routers, see www.bsdrouter.org/.
Also, visit nuinui's world :) at www.nuinui.net.
For questions about me, e-mail <fukachan@fml.org>.
Copyright (C) 1993-2008 Ken'ichi Fukamachi

Powered by NetBSD.