Using Caché Studio - InterSystems Documentation

Class Definition Syntax• Body (optional)These are described below.For example, the following statement defines a method:/// This method returns 1 if successful.Method Test() [ Private ]{Write 1}In this case, the description consists of “This method returns 1 if successful.” ; the declaration consistsof Method Test(); the keyword list contains Private and the body contains Write 1.B.2.2.1 DescriptionA description is a special type of comment that precedes a class or class member and specifies thevalue of the Description keyword for the class or class member.A description is indicated using three slashes, (///). Text between /// and the end of the line is includedin the description.For example, here is a property with a description:/// This property represents a NameProperty Name As %String;If a class definition is closed and reopened, descriptions separated by white space are concatenated,thus:/// This is line one/// This is line twoMethod x(){}becomes:/// This is line one/// This is line twoMethod x(){}and is placed immediately before the element to which they relate when the class definition is regenerated.A description must be placed outside of any statement. A description at the very end of a document(with no member definition following it) is not associated with any member definition and is lost whenthe document is saved or regenerated.150 Using Caché Studio