HASSLE Code documentation

location: Home > Archive > HASSLE > HASSLE code documentation

Chapter 2: HASSLE 5.0 Descriptions of HASSLE Conventions and Functionality

HASSLE 5.0 Descriptions of HASSLE Conventions and Functionality

Copyrighted material. See the Internet Biocompanion Home Page for further information.

Header: /bioy2/biocomputing/eggenber/Hassle/RCS/descriptions.txt,v 1.13 1994/07/17 08:18:48 eggenber Exp eggenber $



Section 2.1: Naming Conventions

[ Previous chapter ][ This chapter ][ Next chapter ]


Subsection 2.1.1

Functions

The name of a function is composed of its action and the object of that action. Both action and object begin with a uppercase letter. Function names contain no underscores. Multiple upper-case letters are used to enhance readability. Example: DoHassle.


Subsection 2.1.2

Modules (C-files)

Due to portability reasons module names are limited to a maximum of 7 characters (not including the ".c" extention). Only lower-case letters are allowed. Underscores are not allowed. Test modules are named as are the modules to be tested but begin with a "v". Example: client.c (module client) vclient.c (testmodule for module client)


Subsection 2.1.3

Variables

The name of variable is composed of a code referring to its type and its description (variable-name), separated by an underscore (only one underscore is allowed). Only lower-case letter are allowed.

Table of variable-types: (to be used in the following order, eg uda: unsigned double array)

 
s signed	c char		a array  
u unsigned	d double	p pointer	  
		f float  
		i int  
		l long  
		s struct  
		v void  
Example: cp_hostname (pointer to the string described as "hostname")


Subsection 2.1.4

Macro definitions (in *.h files)

Constants: description in upper-case letters, underscores allowed. Macros: description of action and object of that action, separated by an underscore. Only upper case letters are allowed.


[ Previous chapter ],[ This chapter ][ Next chapter ] [next page/section] , or [overview] , or [table of contents]