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.9 -r1.10 --- openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 28 Feb 2003 05:36:04 -0000 1.9 +++ openacs-4/packages/acs-core-docs/www/eng-standards-plsql.html 24 Jun 2003 03:58:11 -0000 1.10 @@ -1,9 +1,9 @@ -PL/SQL Standards
Prev Chapter 8. Engineering Standards Next

PL/SQL Standards

+PL/SQL Standards

Prev Chapter�11.�Engineering Standards Next

PL/SQL Standards

By richardl@arsdigita.com and yon@arsdigita.com


- OpenACS docs are written by the named authors, but may be edited + OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.

Like any other part of the OpenACS, PL/SQL (or pl/pgsql) code must be @@ -12,7 +12,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 @@ -24,7 +24,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 @@ -143,7 +143,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.

  1. @@ -153,4 +153,4 @@ as possible to all source code readers.

  2. Lowercase everything, with the exception of %TYPE and %ROWTYPE. -

($Id$)
Prev Home Next
ACS File Naming and Formatting Standards Up Chapter 9. Kernel Documentation
rmello at fslc.usu.edu
vinod@kurup.com
View comments on this page at openacs.org
+

($Id$)
Prev Home Next
ACS File Naming and Formatting Standards Up Appendix�C.�Install Red Hat 8.0
docs@openacs.org
View comments on this page at openacs.org