phsjhxx

More documents

Recommendations

Info

4.1.1 Tool support Formatting your code as described above may be achieved using various tools. We have written templates for • SQL Navigator • Toad • PL/SQL Developer 4.1.2 Code Formatting Files Formatting Tool and Templates Tool Quest SQL Navigator Quest Toad www.sqlinform.com PL/SQL Developer TORA File Name SQLNavigatorFormating.opt SQLNavigatorFormating.opt PL-SQL-Developer-Beautifier.zip 4.2. Code Commenting Inside a program unit only use the line commenting technique “--“. To comment the source code for later document generation, comments like /** … */ are used. Within these documentation comments, tags may be used to define the documentation structure. Tags beginning with % are always on a new line (exception {%link…}. Documentation generation can be done using PLSQLDoc (Plugin to PL/SQL Developer and therefore only available when working with this tool) or PLDoc (Open Source Product – no longer improved and therefore not recommendable). Commenting Tags Tag Meaning and Pattern Program Example {*} enumeration within another tag {*} PLSQLDoc {*} 0 this is zero {*} 1 this is one {*} other all others author author of an object PLSQLDoc %author Max Mustermann %author deprecated old version of a program unit PLDoc %deprecated link param raises %deprecated link within text to a location in the documentation or on the Web with alternate display text {%link } parameter of a procedure or function %param raised exception in a program unit %raises PLSQLDoc PLDoc PLSQLDoc PLSQLDoc .. {%link EMP.html EMP}… …{%link http://www.trivadis.com Trivadis-Homepage}… %param p_deptno departmentno. %raises NO_DATA_FOUND description PL/SQL Coding Guidelines 13
Tag Meaning and Pattern Program Example return return value of a function PLDoc %return sum_sal %return PLSQLDoc see reference to a site in the PLSQLDoc %see EMP.html documentation or in the web %see %see skip the current comment is not used for generating documentation {%skip} throws thrown exception in a program unit %throws usage usage of an object %usage value possible values of parameters, results or other variables %value version version number of an object %version PLSQLDoc PLDoc PLSQLDoc PLSQLDoc http://www.trivadis.com … {%skip} …. %throws NO_DATA_FOUND description %usage This object is used to figure out the salary. %value 0 OK %value 1 exception PLSQLDoc %version 3.2.1 To format text in the documentation HTML tags are used inside comment blocks. HTML Tags HTML Meaning Excample Bold text in bold Italic text in italic underline underlined text new line … horizontal line example in courier font if…else… unnumbered list insert a table first second … … … PL/SQL Coding Guidelines 14
Page 1 and 2: PL/SQL & SQL CODING GUIDELINES VERS
Page 3 and 4: Foreword Coding Guidelines are an i
Page 5 and 6: Table of Contents 1. Introduction .
Page 7 and 8: 1. Introduction This document descr
Page 9 and 10: 3.2. Naming Conventions for variabl
Page 11 and 12: Identifier Package Naming Conventio
Page 13: 4. Coding Style 4.1. Formatting PL/
Page 17 and 18: 4.2.1 IDE Templates Code Templates
Page 19 and 20: Example: -- Bad DECLARE l_function
Page 21 and 22: List of possible subtype definition
Page 23 and 24: 5.2.2 Numeric Data Types 18. Avoid
Page 25 and 26: 5.2.5 Large Objects 24. Avoid using
Page 27 and 28: -- Good DECLARE CURSOR c_user IS SE
Page 29 and 30: 31. Avoid procedure or function cal
Page 31 and 32: -- Good BEGIN l_result := CASE dumm
Page 33 and 34: 40. Always use a WHILE loop to proc
Page 35 and 36: 45. Avoid use of unreferenced FOR l
Page 37 and 38: 50. Avoid use of EXCEPTION_INIT pra
Page 39 and 40: 5.6. Dynamic SQL 54. Always use a s
Page 41 and 42: 58. Always use parameters or pull i
Page 43 and 44: 5.7.3 Functions 67. Avoid standalon
Page 45 and 46: 5.8.2 Access objects of foreign app
Page 47 and 48: 6.1.2 CodeXpert The calculation of
Page 49 and 50: 6.2. Cyclomatic Complexity (McCabe
Page 51 and 52: 7. Code Reviews Code reviews check
Page 53: UNSERE STANDORTE BASEL BERN LAUSANN

phsjhxx

Create successful ePaper yourself

Delete template?

Save as template?