Skip to content

Class Member Meta-Data Tag Rules

These rules supplement Meta-Data Tag Format and Rules with information specific to class member meta-data tags.

Class member meta-data tags should be applied to class members as follows:

Properties

  • If a property is declared as public (not explicitly flagged private) on the property declaration line, the meta-data tag should be applied above the property declaration line.

    Class cMyClass is a cObject
        Procedure Construct_Object
            forward send Construct_Object
        { TagName=Value }
        Property Type pMyProperty InitialValue
        End_Procedure
    End_Class
    
  • If the property declaration is private, the meta-data tag should be applied above the Procedure Set declaration (rather than the Function declaration), because the Procedure Set is the "settable" part of a property's accessor method pair (Procedure Set/Function).

    Class cMyClass is a cObject
        Procedure Construct_Object
            forward send Construct_Object
        Property Type pMyProperty private
        End_Procedure
        { TagName=Value }
        Procedure Set pMyProperty Type VariableName
        End_Procedure
    End_Class
    

Methods (Procedures and Functions)

  • The meta-data tag should be applied immediately above the method declaration.

    Class cMyClass is a cObject
        Procedure Construct_Object
            forward send Construct_Object
        End_Procedure
        { TagName=Value }
        Procedure MyProcedure
        End_Procedure
        { TagName=Value }
        Function MyFunction
        End_Function
    End_Class