byte-physics/igor-pro-coding-conventions

Issues

• Add section to always use explicit indexing on the rhs

  #40 opened 5 months ago by t-b
  0

• Always prefer /ZZ over /Z when not wanting to pickup global waves

  #39 opened 9 months ago by t-b
  0

• Operation flags should always be ALL CAPS

  #38 opened a year ago by t-b
  0

• Always handle the default case in switch statements

  #37 opened a year ago by t-b
  0

• Correct evaluation of xop error codes

  #32 opened a year ago by MichaelHuth
  0

• No user code before the first case in a switch statement

  #36 opened a year ago by Garados007
  0

• No code outside of functions

  #35 opened a year ago by Garados007
  0

• Comma placement in function signatures

  #34 opened a year ago by Garados007
  0

• Separate all operation arguments by commas

  #33 opened a year ago by Garados007
  0

• Discuss global variables

  #29 opened 2 years ago by t-b
  3

• Require function prefixes for static and global functions

  #27 opened 2 years ago by Garados007
  1

• Include https://github.com/AllenInstitute/MIES/blob/main/Packages/doc/developers.rst#preventing-debugger-popup

  #20 opened 2 years ago by t-b
  0

• Don't exploit index clipping for character access in strings

  #24 opened 2 years ago by t-b
  0

• Think about mandating wave types `Make`

  #17 opened 2 years ago by t-b
  1

• Prefer named entities over unnamed ones

  #12 opened 2 years ago by t-b
  0

• No code outside switch cases in GUI control procedures

  #13 opened 2 years ago by t-b
  0

• Use separate files when machine generated code (window recreation macros) are large

  #14 opened 2 years ago by t-b
  0

• Adapt wording for break in switch

  #21 opened 2 years ago by t-b
  0

• Avoid generic routines like exists and use the specific ones

  #15 opened 2 years ago by t-b
  0

• Use doxygens @retval for documenting MRS functions

  #18 opened 2 years ago by t-b
  0

• Convert to sphinx with pandoc

  #3 opened 2 years ago by t-b
  0

• For most cases a function returning a wave should prefer a null wave ref over an empty wave

  #26 opened 2 years ago by t-b
  0

• Use correct bit vs. logical operation

  #16 opened 2 years ago by t-b
  1

• With try/catch always clear the RTE to avoid triggering on lingering RTEs

  #7 opened 4 years ago by t-b
  0

• Be aware of the different initial values for return values when using multiple return value syntax

  #8 opened 4 years ago by t-b
  0

• Always break in case statements, use comment like // fallthrough-by-design if not done on purpose

  #10 opened 4 years ago by t-b
  0

• if you dont care about a function result return NaN and not 0 or 1 or ??

  #1 opened 4 years ago by t-b
  0

• Set pass by reference parameters to a save default in error case, use strucuture init functions if required

  #4 opened 4 years ago by t-b
  0

• Don't mix $ with other expressions

  #2 opened 4 years ago by t-b
  0

• Prefer generic functions over 1D ones

  #5 opened 4 years ago by t-b
  0

• Always add a space after ";" when used for writing multiple statements in one line

  #6 opened 4 years ago by t-b
  1

• Function definition

  #9 opened 5 years ago by ukos-git
  1