Development - Naming

From Bluefish Wiki
Revision as of 11:13, 9 July 2010 by Bill Valaski (talk | contribs) (moved Man 2 ch12s02 to Development - Naming: Title updates (BV))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Man2 warning.png This page is a copy from Manual 1. It needs to be modified to match Bluefish version 2.0.0!
Once you have verified this page (and corrected if necessary),

please modify the status to u (updated), i.e. st=u (see Guidelines for Writing this Manual)

Man2 icon 48.png
Chapter XII. Development guidelines
2. Naming

2. Naming

For non-local functions, the name should preferably include a prefix that shows the part of bluefish it is used for. There are, furthermore, many often used abbreviations in the bluefish code, such as:

Abbreviations used in the Bluefish code


A function for handling a specific document


A function for handling a specific Bluefish window


Callback, a function called after a button click or some other event


Local callback, a function called after an event, only used in this .c file

Here are such function names that show where they are from, what they handle, and/or what they do

Examples of function names in Bluefish


Bookmark code, sets bookmarks for a document


Spell check code, this is a callback function (for a button)


Project code, opens a new project from a given file name

Chapter XII. Development guidelines
Home | ToC
 3. Declaring procedures