Skip to content

Instantly share code, notes, and snippets.

@ax3l

ax3l/CodingGuideLines_PIConGPU.md

Last active December 20, 2015 20:49
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ax3l/6193153 to your computer and use it in GitHub Desktop.
Save ax3l/6193153 to your computer and use it in GitHub Desktop.
Download ZIP
New PIConGPU Coding Guide Lines - Draft
Raw
CodingGuideLines_PIConGPU.md
  • TypeNames and objects, e.g. const Event event;
  • close namespaces with a comment: } // namespace itsName
  • Makros with newlines: align \ symbol to column 80
  • Describe how PreProcessor Macros are unrolled (excellent example)
/*      < typename T0, ... , typename TN    > */
template<BOOST_PP_ENUM_PARAMS(N, typename T)>
/*                      ( const T0, ... , const TN        ) */
HDINLINE void operator()( BOOST_PP_ENUM_PARAMS(N, const T)) const

branch naming conventions

  • master -> tags: alpha, beta, 1.0
  • dev -> release-... -> master (tagged commit)
  • topic-myNewFeature or feature-myNewFeature ?
  • fix-aHotfixName

Auto-Testing via ?

@psychocoderHPC
Copy link

To PreProcessor Makro:
One small thing I have done is that the symbol before and after PreProcessor macro are on the same position (if possible).

/*      < typename T0, ... , typename TN    > */
template<BOOST_PP_ENUM_PARAMS(N, typename T)>
/*                      ( const T0, ... , const TN        ) */
HDINLINE void operator()( BOOST_PP_ENUM_PARAMS(N, const T)) const

@ax3l
Copy link
Author

ax3l commented Sep 17, 2013

perfect. absolutely nice to read compared to the plain macro !

@ax3l
Copy link
Author

ax3l commented Jan 21, 2014

Moved to PIConGPU Wiki

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment