Using Caché Studio - InterSystems Documentation

Using HTML in DescriptionsCaché uses descriptions to create documentation for the class in its online class reference (samples:%XML.Adaptor,%UnitTest.TestCase). You can use HTML tags to format the description. Inaddition to standard HTML, the online reference recognizes the following tags: CLASS, METHOD,PROPERTY, PARAMETER, QUERY, and EXAMPLE. CLASS, METHOD, and PROPERTY aredescribed here. See the documentation for %CSP:Documatic for details of the others.CLASSUse to tag class names. If the class exists, the contents are displayed as a hyperlink to the class' documentation.For example:/// This uses the Person class.Method x(){}METHODUse to tag method names. If the method exists, the contents are displayed as a hyperlink to the method'sdocumentation. For example:/// This is identical to the Unique method.Method x(){}PROPERTYUse to tag property names. If the property exists, the contents are displayed as a hyperlink to theproperty's documentation. For example:/// This uses the value of the State property.Method x(){}Here is a multi-line description using HTML markup:/// The Factorial method returns the factorial/// of the value specified by x.ClassMethod Factorial(x As %Integer) As %Integer{If (x > 1) {Quit x * (..Factorial(x - 1))}Else {Quit x}}General StructureUsing Caché Studio 151