summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPaul Buetow (pluto.buetow.org) <paul@buetow.org>2013-09-28 13:31:48 +0200
committerPaul Buetow (pluto.buetow.org) <paul@buetow.org>2013-09-28 13:31:48 +0200
commit6460ff71ae10f85d7dc12fae40d4c7f05ea41db7 (patch)
tree814b82eafe1fba8e856d2103023873d64e1fd653 /README
parent82530a1cfefe05e63dd7ff80704dd9ccc4a6bb4c (diff)
not in branch hosts
Diffstat (limited to 'README')
-rw-r--r--README73
1 files changed, 0 insertions, 73 deletions
diff --git a/README b/README
deleted file mode 100644
index b9257fc..0000000
--- a/README
+++ /dev/null
@@ -1,73 +0,0 @@
-STYLEGUIDE:
-
-Always do:
-
-Pragmatic modules ALWAYS to use in ALL packages:
-
-use strict;
-use warnings;
-
-Only for packages for including package UNIVERSAL definitions
-
-use Xerl::Page::Base;
-
-Object oriented coding style
-
-Always use method prototypes if possible
-
-sub foo($;$) { .... }
-
-Explicit object typing if possible
-
-my Class::Name::Here $foo = Class::Name::Here->new();
-
-If no real ret val, set undef; explicitly
-
-sub foo() {
- # Do some stuff
-...
-# Set explicit undef ret value
-return undef;
-}
-
-Private subs use _ as its prefix and are called only from the current package.
-
-package Xerl::Foo::Bla;
-.
-.
-
-sub _iamprivate($) {
-my Xerl::Foo:Bla $self = $_[0];
-.
-.
-}
-
-sub iampublic($) {
-my Xerl::Foo:Bla $self = $_[0];
-$self->_iamprivate();
-return undef;
-}
-
-Static subs (not OOP) are in CAPITAL letters.
-
-sub IAMSTATIC($) {
-print shift;
-return 'Hello World';
-}
-
-sub iamdynamic($) {
-my Xerl::Foo:Bla $self = $_[0];
-return Xerl::Foo::Bla::IAMSTATIC( $self->get_somevalue() );
-}
-
-Static private subs start with _ and are written in CAPITAL letters
-
-sub _IAMSTATICPRIVATE() {
-.
-.
-}
-
-Use Pidy to automaically restyle the code! (make perltidy)
-
-Mark things which are still to do with TODO: at any place in the source
-tree. (Can be searched for using 'make todo').