manolas
/
vcglib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

First commit of coding guide

This commit is contained in:
Paolo Cignoni 2004-02-09 00:00:48 +00:00
parent d92878fb64
commit 2431187e1a
1 changed files with 56 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/StyleGuide.htm Normal file
View File

@ -0,0 +1,56 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
<TITLE></TITLE>
<META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.0 (Win32)">
<META NAME="CREATED" CONTENT="20040209;363169">
<META NAME="CHANGEDBY" CONTENT="Paolo Cignoni">
<META NAME="CHANGED" CONTENT="20040209;1022370">
<STYLE>
<!--
@page { size: 21.59cm 27.94cm; margin: 2cm }
P { margin-bottom: 0.21cm }
H1 { margin-bottom: 0.21cm }
H1.western { font-family: "Arial", sans-serif; font-size: 16pt }
H1.cjk { font-family: "MS Mincho"; font-size: 16pt }
H1.ctl { font-family: "Tahoma"; font-size: 16pt }
H2 { margin-bottom: 0.21cm }
H2.western { font-family: "Arial", sans-serif; font-size: 14pt; font-style: italic }
H2.cjk { font-family: "MS Mincho"; font-size: 14pt; font-style: italic }
H2.ctl { font-size: 14pt; font-style: italic }
-->
</STYLE>
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<H1 CLASS="western">VCG Library Coding Guide</H1>
<H2 CLASS="western">Naming Rules</H2>
<P STYLE="margin-bottom: 0cm"><B><I>Class</I></B> names with first
letter Uppercase and internal uppercase to separate compound words.</P>
<P STYLE="margin-bottom: 0cm"><B><I>Function members</I></B> of
classes follow the same rule.</P>
<P STYLE="margin-bottom: 0cm"><B><I>Public Variable members</I></B>
has the first letter lowercase and internal uppercase to separate
compound words.</P>
<P STYLE="margin-bottom: 0cm"><B><I>Private Variable members</I></B>
has an underscore as first char and the first letter lowercase and
internal uppercase to separate compound words.</P>
<P STYLE="margin-bottom: 0cm"><B><I>Class Template Arguments</I></B>
all capitalized and with names remembering where they have been
defined.</P>
<H2 CLASS="western">Header Files</H2>
<P STYLE="margin-bottom: 0cm">Each file of the library has to include
all the files that it requires.</P>
<P STYLE="margin-bottom: 0cm">Header filenames and folders are always
fully lower case. Compound names are separated by '_'.</P>
<P STYLE="margin-bottom: 0cm">In Class definitions place prototypes
all togheter before the inline or templated implemetations.</P>
<H2 CLASS="western">Editing Rules</H2>
<P STYLE="margin-bottom: 0cm">Tabs are equivalent to two spaces.
</P>
<P STYLE="margin-bottom: 0cm">There are no strict rules for the
plaement of '{' or indenting.</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
</BODY>
</HTML>