By Michael Yoon and Aurelius -Prochazka
</authorblurb>To ensure consistency (and its collateral benefit, +File Naming and Formatting Standards
To ensure consistency (and its collateral benefit, maintainability), we define and adhere to standards in the following areas:
This can be at the top or bottom of the file.
Using ad_page_contract
For non-library Tcl files (those not in the private Tcl +
This can be at the top or bottom of the file.
For non-library Tcl files (those not in the private Tcl
directory), use ad_page_contract
after the file path
comment (this supersedes set_the_usual_form_variables and
ad_return_complaint). Here is an example of using ad_page_contract,
@@ -148,7 +150,7 @@
does not generate QQvariables, which were automatically created by
ad_page_variables and set_the_usual_form_variables. The use of bind
variables makes such previous variable syntax obsolete.
Using ad_library
For shared Tcl library files, use ad_library
after the file path comment.
+
For shared Tcl library files, use ad_library
after the file path comment.
Its only argument is a doc_string in the standard (javadoc-style)
format, like ad_page_contract
.
Don't forget to put the \@cvs-id in there. Here is an example of
@@ -161,7 +163,7 @@
\@author John Doe (jdoe\@example.com)
\@cvs-id file-standards.html,v 1.2 2000/09/19 07:22:45 ron Exp
}
-
Non-Tcl Files
For SQL and other non-Tcl source files, the following file +
For SQL and other non-Tcl source files, the following file header structure is recommended:
-- path relative to the ACS root directory
--
@@ -214,8 +216,8 @@
Further standards for Tcl library files are under discussion; we -plan to include naming conventions for procs.
($Id: filenaming.xml,v 1.8 2017/08/07 -23:47:54 gustafn Exp $)
+plan to include naming conventions for procs.