Index: openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html,v diff -u -r1.31.2.4 -r1.31.2.5 --- openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 22 Oct 2004 02:38:14 -0000 1.31.2.4 +++ openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 1 Nov 2004 23:39:42 -0000 1.31.2.5 @@ -1,4 +1,4 @@ -PL/SQL Standards

PL/SQL Standards

+PL/SQL Standards

PL/SQL Standards

By Richard Li and Yon Feldman

OpenACS docs are written by the named authors, and may be edited @@ -10,7 +10,7 @@ our product will be useful long after the current people building and maintaining it are around. Following are some standards and guidelines that will help us achieve this goal: -

General

  1. +

    General

    1. All PL/SQL code must be well documented. We must write code that is maintainable by others, this is especially true in our case because we are building an open source toolkit than anyone can @@ -22,7 +22,7 @@ as is possible given the nature of team development. This means carrying style and other conventions suchs as naming within an application, not just within one file. -

    Code

    1. +

    Code

    1. Encapsulation of related fuctionality is key to maintainability and upgradeability of our software. Try to bundle your code into packages @@ -141,7 +141,7 @@ click protection, that is, tehy have already gotten an object_id and now they want to create the object with that object_id. -

    Style

    +

Style

Some general style guidelines to follow for the purpose of consistency across applications.