YAPC::NA 2004 Perl Style Guides for Large Projects #11

Ensembl's Coding Standards

  1. Use Bioperl sensibly

    • Inherit from existing objects

  2. Differentiate internal from external methods

    • Internal methods are preceded by _ and external ones are not.

  3. Throw exceptions

    • Make heavy use of the Bioperl $obj->throw syntax to throw exceptions when things look wrong. This drastically cuts down time tracking errors.

  4. Document with Bioperl POD

    • Use bioperl boilerplate for method documentation.

  5. Always test

    • Testing your code with the Perl test system provides for long term stability.

    • Your code is not written until you have written a test for it.

      • <<alternative statement: "Do not write your code until you have written a test for it.">>

<< Previous | Index | Next >> Copyright © 2004 Daniel Allen