====== Coding guidelines ======

The following are guidelines used for the code in METAMOD. They are for the most part meant as gentle guidelines and not strict rules. Use them when it makes sense to do so.

===== Perl =====

==== Follow the suggested style ====

**Status:** Suggested

**Reason:** A consistent syntax style increases readability and makes it easier to see the real difference between versions.

**More information:** The style guide for Perl is found [[perl_code_style|here]].



==== Use underscore in variable names ====

**Status:** Suggested

**Reason:** This is the convention most commenly used in Perl.

**Example:** ''my $longer_var_name''



==== Use underscore in function names ====

**Status:** Suggested

**Reason:** This is the convention most commenly used in Perl.

**Example:** ''sub longer_sub_name {}''


==== Use CamelCase in package and class names ====

**Status:** Suggested

**Reason:** This is the convention most commenly used in Perl.

**Example:** ''package Some::PackageName''