RE: Adding Descriptions to properties and methods???

Author: Tracy Pearson

Posted: 2011-08-15 at 13:48:08

Matt Slay wrote on 2011-08-15:

> In a class definitions contained in a VCX, you can add a Description to

each

> custom property and method that you define.

>

>

> However, I am creating a class definitions in a PRG file, and I want to

know

> if there is a standard way of using comments or some other kind of markup

in

> the class definition to include descriptions for the properties and

methods?

>

>

... <snip/>

Matt,

You're bordering on a religious topic.

Many times comments don't get updated when code changes. Though when

designing a class that will be shared with others, it's nice to know what is

parameters are expected, C#'s strict rules show this. In VFP we can use the

AS clause in the LPARAMETERS to give that information.

There is a documented structure for commenting a COM object in the help.

Tracy Pearson

PowerChurch Software

_______________________________________________

Post Messages to: ProFox@leafe.com

Subscription Maintenance: http://leafe.com/mailman/listinfo/profox

OT-free version of this list: http://leafe.com/mailman/listinfo/profoxtech

Searchable Archive: http://leafe.com/archives/search/profox

This message: http://leafe.com/archives/byMID/profox/002801cc5b73$7e8e1870$7baa4950$@powerchurch.com

** All postings, unless explicitly stated otherwise, are the opinions of the author, and do not constitute legal or medical advice. This statement is added to the messages for those lawyers who are too stupid to see the obvious.

©2011 Tracy Pearson