Subject: RE: best practices for managing xsl library
From: "Michael Kay" <mike@xxxxxxxxxxxx>
Date: Mon, 2 Jan 2006 23:03:22 -0000
|
> * Parameters for templates should use sensible names. Where
> possible (or if in doubt), follow these conventions:
> o A parameter containing a single node is named node. Where more
> than one parameter contains a single node, the suffix Node is
> appended to the parameter name, eg. referenceNode
> o A parameter which potentially contains multiple nodes is named
> nodes. Where more than one parameter potentially contains multiple
> nodes, the suffix Nodes is appended to the parameter name,
> eg. copyNodes
> o A parameter which contains a string value is named text.
Much better than naming conventions, in 2.0 you can declare the type of the
parameter. This should be a mandatory coding standard: it's really useful
documentation, and it also catches a great number of silly coding mistakes.
See http://www.stylusstudio.com/schema_aware.html - though this technique is
useful even without a schema, and works for template parameters as well as
function parameters.
Michael Kay
http://www.saxonica.com/
|