Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This document serves as a guideline for the formatting of Perl code for use within the IEPM department. The use of consistent formatting and helpful documentation of code will ease development, faciliate debugging and enable collaboration of code.
Due to the numerous styles by which people code and formatting text, it is currently recommended that the lead author (or designated maintainer) of the code in question specified the desired code style for that perl script/module only.

This is a temporary solution from which we as a group must determine the best practise code styles from which we can base future decisions on code formatting which will be suitable for us as a group. In time, we expect to learn from each others code styles to learn the benefits and disadvantages of each and therefore evolve to a standard code style.

Code which will be distributed to others not of our group, should be formatted under the recommended perl formatting specifications as defined in Perl Style Guide.

...

To ease formatting and translations of the various coding styles available, it is recommended that the tool PerlTidy should be used to (re)format code to the format desired.

The idea is to (re)format code to the desired style for editing and or distribution. However, as suggested above, the code should be formatted to the desired code style of the code maintainer/author.

...