You are here

Home › Newsletters › ams › Coding Practices › In Code Documentation

Method Documentation

Subscribe to Syndicate
In each public method, the following standards are to be observed as per the example below:
  • a description for each parameter must be entered in the upper area
  • In the method, at the top, is a description of the purpose of the method
  • The parameters are repeated in text format as part of the method so that when a method is over-ridden, the parameter description will be copied into the over-ridden method.
  • If there is an expected return value, document those at the top of the method

Also indicate if this method should never be over-ridden except in rare cases, could be overridden, or should be overridden.