Commenting code

[DonH]

I don't see anyway to do this, but best practices do direct us to comment our code for future reference, so is there anyway to do this in FM? Other than seperate documents that is.

[ernst]

Later version of Filemaker ( ?5 ? ) do have a 'Comment' script step.

[-Queue-]

If #Comment is not available, an oft-used option is to tag calculations and Set Fields with Left( "comment comment comment", 0 ) & your calc here.

[DonH]

This is version 3.0.

[Vaughan]

FMP versions before 3.0v6 are not Y2k compliant.

[DonH]

Good thing to note, tho not sure how it fits in with commenting code

[ernst]

Maybe it's Vaughan's way to say:"Yet another good reason to upgrade."

[Vaughan]

I just think it's a shame people put in the effort to learn an old version of a program. It means they're going to have to un-learn and re-learn when the program inevitably becomes obsolete as OSs evolve, and their hard-learned skills aren't worth anything (for instance, who wants to employ a FMP 2.1 expert?)

Sure, we all can't afford latest versions, but developing in v3.0 when the current version is 6.0 (which is really five versions newer, not just three) seems such a shame. Download the trial version of FMP or buy a more recent version off eBay or something.

[BobWeaver]

I agree. I finally managed to convince one of my clients to upgrade from version 3 to 6 about a month ago. Suddenly, we can implement all the changes that they've been asking me about for the last four years.

Unfortunately, office politics tends to impede progress a lot of the time.

[rogermax]

Question on commenting code:

As it is possible to print the field definitions of a file...can anyone tell me if it is possible grab or push that data into another db automatically (without copy and paste) to track changes and/or comment at will. Essentially to keep a database of databases where each record is a field of another db. Would allow easy grouping by project and so on.

[BobWeaver]

Here is a free utility that I posted:

http://www.fmforums.com/threads/showflat.php?Cat=&Number=51415&page=6&view=collapsed&sb=5&o=365&fpart=1

You can also buy Analyzer and Brushfire.

My utility only works on version 5 or newer. So if you are stuck with an older version, you can use a demo copy of FM 6 to convert the files and then run the utility.

[rogermax]

Thanks Bob.

I have FMD5.5 and thus have the documentor. I was hoping for some way that I could extract the field definitions myself (doesn't appear possible on Windows with your analyzer above--unless I missed something). I had hoped to be able to track modifications in the Database Documentor but I don't think you can.

So I will likely build off of the DD.

[BobWeaver]

My analyzer will work in windows, but you won't get the features which require applescript, namely the calculation field formulae and the global field values. But you will get the other field definition info.

Also, I've never had the hardware available to test out the script documentation part on Windows, so until I hear otherwise, I have to assume that it doesn't work.

[cjaeger]

Developer Documentation:

Why not use a special Layout with all fields & add comments as plain & simple (layout) text. No need for separate docs. make sure you hide the layout from "nomal" users.

[DonH]

It is far better to put your comments in line with your code. Makes it clearer.

Otherwise you have to duplicate your code totally onto another document, which may not be bad either, but just takes extra time.

As I've taught many an intern, commenting code is NOT for other people. It is for you when you have to come back to a project after 2 years and figure out what you did and fix it.

[-Queue-]

Does FM 3 not have a Comment script step available?

[BobWeaver]

Hmm, had to stop and think for a second, but yes FM3 does have a comment step. Otherwise I never would have been able to go through and comment all the scripts that the previous developer had left completely uncommented.

[DonH]

Hmmm. I haven't seen it. And the original developer probably couldn't figure out his own work enough TO comment it. lol

[rogermax]

yes...comment inline. For some things I do use a separate layout (actually in another db for that purpose), but would like to do it within the calc window to comment on the more complex calcs. I have come to rely heavily on the comment script step.

[-Queue-]

It should be under the Miscellaneous category of script steps, then. I rely heavily on this, too, as well as the Left( "Comment", 0 ) & calc for egregiously complicated If [ ], Set Field [ ], Replace [ ], etc. steps.

[DonH]

Yup. Thar she blows. In the MISC way down at the bottom. Hiding out.