Documentation/Nightly/Developers/Style Guide

From Slicer Wiki
Jump to: navigation, search
Home < Documentation < Nightly < Developers < Style Guide

Code style

Code that inherits from VTK classes should follow VTK coding conventions for naming, indentation, etc. See http://www.vtk.org/Wiki/VTK_Coding_Standards for details.

Naming

  1. Acronyms should be written with the same case for each letter (all uppercase or all lowercase).
    RASToSlice not RasToSlice
    vtkMRML not vtkMrml
    vtkSlicer not vTKSlicer
  2. Words should be spelled out and not abreviated
    GetWindow not GetWin
  3. File names must follow the Camel case convention
    TestMyFeature.cxx not Test-My_Feature.cxx
  4. Use US English words and spelling
    "Millimeter" not "Millimetre"
    "Color" not "Colour"

Comments

  1. include extensive comments in the header files
  2. keep the comments up to date as the code changes
  3. use the keyword \todo to flag spots in the code that need to be revisited
  4. do not leave blocks of commented out code in the source file -- if needed insert links to prior svn versions as comments

Functions

  1. Don't mix different levels of abstraction
    Examples:
    When dealing with files names and path, use kwsys::SystemTools in VTK classes, QFileInfo/QDir in Qt classes or os.path in python. Instead of doing string manipulation manually:
    QString filePath = directoryPath + "/" + fileName + ".exe")
    prefer instead:
    SystemTools::JoinPath(), SystemTools::GetFilenameName()...
    QFileInfo(QDir directory, QString fileName), QFileInfo::suffix(), QFileInfo::absoluteFilePath()...
    os.path.join(), os.path.splitext(), os.path.abspath()...
    References:
    • Clean Code from Robert C. Martin: Mixing levels of abstraction within a function is always confusing. Readers may not be able to tell whether a particular expression is an essential concept or a detail. Worse, like broken windows, once details are mixed with essential concepts, more and more details tend to accrete within the functions.
    • http://zuskin.com/coding_habits__functions.htm#Abstraction_levels
  2. Use STL where you can, but follow the VTK guidelines
    1. However, prefer Qt Container classes to STL classes in Qt files
    2. Note that a vtkCollection is somewhat equivalent to std::list<vtkSmartPointer<vtkObject*> >

Language Specific

  1. C++
  2. Python
  3. CMake

Library Dependencies

  1. MRML classes should only depend on vtk and itk (not Slicer Logic or Qt)
  2. Logic classes depend on MRML to store state
  3. Logic classes should encapsulate vtk and itk pipelines to accomplish specific slicer tasks (such as resampling volumes for display)
  4. GUI classes can depend on MRML and Logic and Qt

Development Practices

  1. While developing code, enable VTK_DEBUG_LEAKS (ON by default) in your vtk build and be sure to clean up any leaks that arise from your contributions.

Coordinate Systems

  1. World space for 3D Views is in RAS (Right Anterior Superior) space. See Coordinate systems.
  2. All units are expressed in Millimeters (mm)

Error and warning messages

  • Errors: Error should be used to signal something that should not happen. They usually mean that the execution of the current function/code should be stopped.
  • Warnings: Warning should be used to signal potentially dangerous behavior.
  • Debugs: For general debug and developer aimed information, one can use the debug messages.
  • In Qt-based classes: 
 if (somethingWrongHappened)
   {
   qCritical() << "I encountered an error";
   return;
   }

 qWarning() << "Be careful here, this is dangerous";

 qDebug() << "This variable has the value: "<< value;

 if (somethingWrongHappened)
   {
   vtkErrorMacro("I encountered an error");
   return;
   }

 vtkWarningMacro("Be careful here, this is dangerous");

 vtkDebugMacro("This variable has the value: "<< value);
  • Also, consider looking at qAssert() (qt-based classes) and assert() (vtk-based classes).

Misc.

  1. No more than 80 characters per line

Commits

Summary

  1. Prefix the commit message title with "BUG:","ENH:","COMP:", "STYLE:". Note the ':' (colon) character.
  2. Explain in the commit message title the "impact of the commit to the user"
  3. Add in the commit message body the Mantis issue number prefixed by '#' (pound) character.

Commit message prefix

Subversion Commits to Slicer require commit type in the comment.

Valid commit types are: 

  BUG:   - a change made to fix a runtime issue
           (crash, segmentation fault, exception, or incorrect result,
  COMP:  - a fix for a compilation issue, error or warning,
  ENH:   - new functionality added to the project,
  PERF:  - a performance improvement,
  STYLE: - a change that does not impact the logic or execution of the code.
           (improve coding style, comments, documentation).

Note that the ':'(colon) directly follows the commit tag. For example, it is: "STYLE:" not "STYLE :"

The Subversion command to commit the change is: 

 svn commit -m "BUG: fixed core dump when passed float data" filename1[, filename2, ...]

By using the -m command line option, it's not possible to submit a message having multiple line. Submitting a mutli-line message can be achieved using the -f option: 

 svn commit -f /path/to/message filename1[, filename2, ...]

It's also possible to set the environment variable SVN_EDITOR

Message content

  1. A good commit message title (first line) should explain what the commit does for the user, not how it is done. How can be explained in the body of the commit message (if looking at the code of the commit is not self explanatory enough).
    Examples:
    • Bad: BUG: Check pointer validity before dereferencing -> implementation detail, self-explanatory (by looking at the code)
    • Good: BUG: Fix crash in Module X when clicking Apply button
    • Bad: ENH: More work in qSlicerXModuleWidget -> more work is too vague, qSlicerXModuleWidget is too low level
    • Good: ENH: Add float image outputs in module X
    • Bad: COMP: Typo in cmake variable -> implementation detail, self-explanatory
    • Good: COMP: Fix compilation error with Numpy on Visual Studio
  2. If the commit is related to a mantis issue (bug or feature request), you can mention it in the commit message body by preceding the issue number with a #(pound) character:
BUG: Fix crash in Volume Rendering module when switching view layout

vtkSetAndObserveMRMLNodeEventsMacro can't be used for observing all types of vtkObjects,
only vtkMRMLNode is expected by vtkMRMLAbstractLogic::OnMRMLNodeModified(...) 
Closes #1641

Where 1641 refers to the issue number in mantis.

  1. Notice the empty 2nd line.

Importing changes from external project/repository

When you update the git tag or svn revision of any external project, explicit in the commit message what the update does instead of just mentioning that an update in made.

This will avoid having a Slicer commit history made of ineligible messages: 

r19180 - ENH: Update git tag
r19181 - BUG: Update svn revision
r19182 - ENH: revision updated
...

Ideally it should be the same message than the commit(s) in the external repository.

Example: ENH: Add feature A in module X instead of ENH: Update git tag

Resources

http://www.na-mic.org/Wiki/index.php/Engineering:Subversion_Repository

http://www.slicer.org/slicerWiki/index.php/Slicer:git-svn

UI Design Guidelines

General guidelines

Panels

Section

Volume Rendering sections

A section is used in a panel to categorize parameters by visually grouping them. In the Volume Rendering module, there are 3 sections: 'Inputs', 'Display', and 'Advanced...'. By default, the 'Inputs' and 'Advanced...' sections are collapsed. This reduces visual cluttering by hiding advanced and rarely used parameters. Sections should be organized in such a way that the workflow takes the user from top to bottom:

  1. The 'Inputs' section is first as it controls the inputs of the volume rendering.
  2. then the 'Display' section controls important display properties
  3. finally, if the previous parameters are not enough to obtain the desired result, the Advanced.. section offers fine tuning of the volume rendering.

Please note that the Advanced-ness of a section doesn't necessarily impacts its position in the section ordering. To create a section you must use a ctkCollapsibleButton [1] with no panel frame. Typically, the main node selector (Volume: in Volume Rendering) is the first GUI element and is outside any section.

Parameters

Justify elements in panel

Elements in panels should be justified (use of a QFormLayout can simplify the task)

Text

  1. Capitalize the first letter in any text specified for a label or button:
    "Load volumes" instead of "Load Volumes"
    More capitalization rules
  2. Try to use brief phrases when specifying text for a label or button rather than using sentences or sentence fragments ( use "Load volumes" instead of "Choose a volume to load")
  3. Provide fully descriptive tool tips with each widget defined
  4. Don't use colon after each parameter labels:
    "Load volumes" instead of "Load volumes:"
  5. Use US English and avoid abbreviations (see the Naming section above.)

Layouts

  1. Use the default values for the margins or 0. Default margins are automatically controlled by the Slicer custom style (see QStyle::PM_LayoutLeftMargin)
  2. The minimum size hint of the top level module widget is used to determine the minimum width of the module. The minimum width of a module must not be larger than 500px (subject to change). This is enforced by the automatic test qSlicerMY_MODULE_NAMEModuleGenericTest. If the width is too large, you have multiple ways of narrowing the module panel:
    1. In Qt Designer, you can ensure the sizing is correct by changing the QLayout::SizeConstraint to QLayout::SetMinimumSize. When you preview the module (Ctrl-R), it appears with the same size as it would in Slicer.
    2. Ideally the minimum size hint of each wide GUI element should be fixed, it is unlikely that a large size hint is "ideal".
    3. Alternatively, you might want to investigate the following:
      1. Consider setting the horizontal size policy of such element to QSizePolicy::Ignored
      2. If the element is in a form layout, QFormLayout::layoutFieldGrowthPolicy might need to be set to AllNonFixedFieldsGrow.
      3. All those changes can be set from Qt Designer.

Links

Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Developers/Style_Guide&oldid=31806"