Editing C++ style guide

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 142: Line 142:
 
=== Order of Includes ===
 
=== Order of Includes ===
  
In source files (not headers files), use the following order with an empty line between each section:
+
Use the following order with an empty line between each section:
  
 
# config.h
 
# config.h
Line 165: Line 165:
 
* liboctave '''must not''' use any headers or symbols from libinterp or libgui.  It must be fully functional without the interpreter or GUI.
 
* liboctave '''must not''' use any headers or symbols from libinterp or libgui.  It must be fully functional without the interpreter or GUI.
 
* libinterp '''must not''' use any headers or symbols from libgui.  It must be fully functional without the GUI.
 
* libinterp '''must not''' use any headers or symbols from libgui.  It must be fully functional without the GUI.
 
As much as possible, header files should be independent of other header files.
 
 
Header files '''must not''' include config.h.  Instead, they should begin by including octave-config.h.
 
  
 
Header files should not use any "#if defined (HAVE_FEATURE)" conditionals.  This is not quite true yet, but we are almost there.  '''No new conditionals may be added.'''
 
Header files should not use any "#if defined (HAVE_FEATURE)" conditionals.  This is not quite true yet, but we are almost there.  '''No new conditionals may be added.'''

Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page: