From 63b1af2d43493d49e2cadff0653b8933702311d9 Mon Sep 17 00:00:00 2001 From: rds <rds> Date: Wed, 9 Feb 2005 10:54:15 +0000 Subject: [PATCH] <removed>added naming guide for zmap functions</removed> which had already been added. <goodIdea>read the file first</goodIdea> --- doc/coding_notes.html | 32 ++++---------------------------- 1 file changed, 4 insertions(+), 28 deletions(-) diff --git a/doc/coding_notes.html b/doc/coding_notes.html index db2c1952b..2e15057ed 100755 --- a/doc/coding_notes.html +++ b/doc/coding_notes.html @@ -9,7 +9,7 @@ <p>This is simply a collection of notes about coding stuff to maintain consistency.</p> - <p>A good way to maintain consistency is have the editor do the indenting/commenting + <P>A good way to maintain consistency is have the editor do the indenting/commenting etc. If you use the right profile code then there are some emacs functions to do this which include:</p> @@ -60,31 +60,9 @@ font size. <b>BUT</b> exceeding this length occasionally is not a problem.</p> -<<<<<<< coding_notes.html - -<h2>Naming Style</h2> - -<p>It's useful to distinguish between the following sets -of functions that are external in the linker sense: -</p> -<ul> - <li>functions that are part of the external interface of a package</li> - <li>functions that are internal to the package but need to be shared by several -files within the package.</li> -</ul> - -<p>Hence the convention is:</p> -<ul> - <li>zMapNNNNN for external interface functions</li> - <li>zmapNNNNN for functions that are internal to the package</li> -</ul> -</p> - -<!-- horizontal rule --> -======= <h2>Type, Function and variable naming</h2> -<P>General naming conventions: +<P>General naming conventions:</p> <ul> @@ -98,7 +76,7 @@ files within the package.</li> <h3>Function names</h3> <P>Its useful to adopt different naming styles for external interface functions, internal interface -functions and static functions: +functions and static functions:</p> <ul> @@ -121,10 +99,8 @@ functions and static functions: - ->>>>>>> 1.2 +<!-- horizontal rule --> <HR> - <ADDRESS><a href="mailto:edgrif@sanger.ac.uk">Ed Griffiths <edgrif@sanger.ac.uk></a></ADDRESS> <!-- hhmts start --> Last modified: Tue Apr 27 15:41:36 BST 2004 -- GitLab