fabianlupa / abap-annotation-processing Goto Github PK

Since this implementation is not "compiler-bound" there are no technical restrictions as to when something can be annotated. However, semantically there should be restrictions.

To be implemented in each processor in this method:
https://github.com/flaiker/abap-annotation-processing/blob/master/src/proc/zcl_aap_proc_base.clas.abap#L48

• Using abapGit
• And or using transport of copies

Developer documentation (abapDoc) should also be deployed somewhere (github pages?).

Something like "Add annotation" in the quick assist popup for classes, attributes, methods, parameters.

• CX_DYNAMIC_CHECK
  • Caller is responsible for the error (user mistake for not respecting pre conditions or parameter documentation), exception should not be caught
• CX_STATIC_CHECK
  • Expected fail state of the api, caller should (and should be able to) handle this error, exception should be caught
• CX_NO_CHECK
  • Internal error, should not be caught
• ASSERT
  • Internal state validation, should never fail, if it does there is a programming error in the library

Not sure if that would gain or lose performance, or even if abapGit supports SHM areas etc.

a tip, you can have a /docs folder exposed to github pages, see
https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/

this way you dont need the gh-pages branch, and no need to push automatically/manually to pages branch