beverly

Standards in naming objects in Filemaker

Discussion created by beverly Expert on Aug 12, 2016
Latest reply on Aug 12, 2016 by beverly

If you haven't been here, check it out:

 

1. the Background (button) points you to this Standards Document (while referencing .fp7, has great merit today!)

 

2. in this wondrous document, there is a recommendation on Scripts and Script Documentation (p. 53). The Screenshot shows "old style" when comments wrapped better. Now I propose this change (to single line comments):

 

====

If

      

          1. Name: <<scriptname>> #####

     Set Variable 

     #

      

        1. HISTORY ####

      

  1. Created (date, by): 2016-08-12, bvoth

      

  1. Modifed (date, by): 2016-08-12, bvoth, comments inline on changes

     #

      

        1. PURPOSE ####

     #<<purpose of this script>>

     #

      

        1. DECLARED VARIABLES ####

      

  1. $var1 - <<details>>

      

  1. $var2 - <<details>>

     #

      

        1. REFERENCED VARIABLES ####

      

  1. $$var1 - <<details>>

      

  1. $$var2 - <<details>>

     #

      

        1. PARAMETERS ####

      

  1. Get ( ScriptParameter ) or Get ( ScriptResult )

     Set Variable

     Set Variable

      

  1. param1 - <<details>>

      

  1. param2 - <<details>>

     #

      

        1. IMPORTANT NOTES ####

     #<<add as needed>>

      

  1. for example, copy the script steps here and paste at the beginning of every script! make revisions as needed

End If

====

 

3. pay close attention to the NAMING for all the objects in FM.

 

Anyway, I mostly wanted to point the newbies (and the oldies) to these great resources.

 

beverly

 

Outcomes