Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Z
zmap
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Iterations
Wiki
Requirements
Jira
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ensembl-gh-mirror
zmap
Commits
63b1af2d
Commit
63b1af2d
authored
20 years ago
by
rds
Browse files
Options
Downloads
Patches
Plain Diff
<removed>added naming guide for zmap functions</removed>
which had already been added. <goodIdea>read the file first</goodIdea>
parent
a43020ac
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/coding_notes.html
+4
-28
4 additions, 28 deletions
doc/coding_notes.html
with
4 additions
and
28 deletions
doc/coding_notes.html
+
4
−
28
View file @
63b1af2d
...
@@ -9,7 +9,7 @@
...
@@ -9,7 +9,7 @@
<p>
This is simply a collection of notes about coding stuff to maintain consistency.
</p>
<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
etc. If you use the right profile code then there are some emacs functions
to do this which include:
</p>
to do this which include:
</p>
...
@@ -60,31 +60,9 @@ font size. <b>BUT</b> exceeding this length occasionally is not a problem.</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>
<h2>
Type, Function and variable naming
</h2>
<P>
General naming conventions:
<P>
General naming conventions:
</p>
<ul>
<ul>
...
@@ -98,7 +76,7 @@ files within the package.</li>
...
@@ -98,7 +76,7 @@ files within the package.</li>
<h3>
Function names
</h3>
<h3>
Function names
</h3>
<P>
Its useful to adopt different naming styles for external interface functions, internal interface
<P>
Its useful to adopt different naming styles for external interface functions, internal interface
functions and static functions:
functions and static functions:
</p>
<ul>
<ul>
...
@@ -121,10 +99,8 @@ functions and static functions:
...
@@ -121,10 +99,8 @@ functions and static functions:
<!-- horizontal rule -->
>>>>>>> 1.2
<HR>
<HR>
<ADDRESS><a
href=
"mailto:edgrif@sanger.ac.uk"
>
Ed Griffiths
<
edgrif@sanger.ac.uk
>
</a></ADDRESS>
<ADDRESS><a
href=
"mailto:edgrif@sanger.ac.uk"
>
Ed Griffiths
<
edgrif@sanger.ac.uk
>
</a></ADDRESS>
<!-- hhmts start -->
<!-- hhmts start -->
Last modified: Tue Apr 27 15:41:36 BST 2004
Last modified: Tue Apr 27 15:41:36 BST 2004
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment