Add an item about prefixing #define names and enum names with a prefix

to avoid name collisions.

svn path=/trunk/; revision=8649
This commit is contained in:
Guy Harris 2003-10-09 18:57:37 +00:00
parent 98b0611239
commit 23f4abb9f9
1 changed files with 8 additions and 3 deletions

View File

@ -1,4 +1,4 @@
$Id: README.developer,v 1.79 2003/10/06 19:11:41 guy Exp $
$Id: README.developer,v 1.80 2003/10/09 18:57:37 guy Exp $
This file is a HOWTO for Ethereal developers. It describes how to start coding
a Ethereal protocol dissector and the use some of the important functions and
@ -189,6 +189,11 @@ as some compilers will reject the first of those statements. Instead,
initialize the array at the point at which it's first declared, so that
the size is known.
For #define names and enum member names, prefix the names with a tag so
as to avoid collisions with other names - this might be more of an issue
on Windows, as it appears to #define names such as DELETE and
OPTIONAL.
1.1.2 Name convention.
Ethereal uses the underscore_convention rather than the InterCapConvention for
@ -226,7 +231,7 @@ code inside
is needed only if you are using the "snprintf()" function.
The "$Id: README.developer,v 1.79 2003/10/06 19:11:41 guy Exp $"
The "$Id: README.developer,v 1.80 2003/10/09 18:57:37 guy Exp $"
in the comment will be updated by CVS when the file is
checked in; it will allow the RCS "ident" command to report which
version of the file is currently checked out.
@ -236,7 +241,7 @@ version of the file is currently checked out.
* Routines for PROTONAME dissection
* Copyright 2000, YOUR_NAME <YOUR_EMAIL_ADDRESS>
*
* $Id: README.developer,v 1.79 2003/10/06 19:11:41 guy Exp $
* $Id: README.developer,v 1.80 2003/10/09 18:57:37 guy Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com>