summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorPaul Buetow (centauri) <puppet@mx.buetow.org>2015-08-09 10:53:07 +0100
committerPaul Buetow (centauri) <puppet@mx.buetow.org>2015-08-09 10:53:07 +0100
commit2b40c40f32cecf6c3a82a0e88c0459084e73011a (patch)
treeb1089baaafb381f1693aceeaa65065bf3334eee3 /README
parent7397ede1a0805f3bc0a14f04b6e4b4b38db168e6 (diff)
parent2fab3867d291514b6666a8bd582fe8ae4896a1c0 (diff)
Merge
Diffstat (limited to 'README')
-rw-r--r--README74
1 files changed, 0 insertions, 74 deletions
diff --git a/README b/README
deleted file mode 100644
index 4b3d8e7..0000000
--- a/README
+++ /dev/null
@@ -1,74 +0,0 @@
-STYLEGUIDE:
-
-Always do:
-
-Pragmatic modules ALWAYS to use in ALL packages:
-
-use strict;
-use warnings;
-use v5.14;
-
-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').