Skip to content
Comments

Comment with ", not with *

Quote comments indent along with the statements they comment

METHOD do_it.
  IF input IS NOT INITIAL.
    " delegate pattern
    output = calculate_result( input ).
  ENDIF.
ENDMETHOD.

Asterisked comments tend to indent to weird places

" anti-pattern
METHOD do_it.
  IF input IS NOT INITIAL.
* delegate pattern
    output = calculate_result( input ).
  ENDIF.
ENDMETHOD.
From SAP/styleguides under CC BY 3.0 — more details
Last updated on
Design goes into the design documents, not the codePut comments before the statement they relate to