I do not use objects - not up to a version of 4D that supports them, yet. My thought on handling documentation of an object's contents... this is probably worth what you are paying for it... :) 1 - In every system, or component install a comment only method outlining your conventions. This contains all of your system's naming conventions, standards etc. This puts the needed information easily available to the programmer(s). I use a method called "__Conventions" as this tends to be the first method in the method list.
2 - For Objects, I would think that extending this idea to the object itself would be useful, and valuable. -- I would think that installing as the first property/value of the object a definition of the contents of that object would allow for each object to be 'self documenting' and might even lead to very generic code. In this way you could blindly access the values in an object. Any value in the object which is not 'documented' as part of Object.content effectively would not exist. i.e. My_Object.Content --> a text(? or whatever floats your boat) value containing all of the expected/allowed values in the object. 3 - You could run a method at shutdown (during development) which would document/comment every object field. This information (object.content) could be put into the table's object field(s) comment(s), and/or into a separate comment only method outlining the structure of every object field. 3a - you could wrap the commands to create a new object (not a field) that would grab or take as a parameter the object's content) Object.content and place it into 1 comment only method for all dynamic objects, or into a 'module' specific comment only method (again only during development). Thoughts? Chip On Thu, 4 Oct 2018 02:45:36 -0700 (MST), Paul Dennis via 4D_Tech wrote: > Thanks Kirk, I was afraid you were going to say that. Ive got multiple > developers on our app all with different habits plus me and I am the worst. > I have to give this some thought. > > > > -- > Sent from: http://4d.1045681.n5.nabble.com/4D-Tech-f1376241.html > ********************************************************************** > 4D Internet Users Group (4D iNUG) > Archive: http://lists.4d.com/archives.html > Options: https://lists.4d.com/mailman/options/4d_tech > Unsub: mailto:[email protected] > ********************************************************************** --------------- Gas is for washing parts Alcohol is for drinkin' Nitromethane is for racing ********************************************************************** 4D Internet Users Group (4D iNUG) Archive: http://lists.4d.com/archives.html Options: https://lists.4d.com/mailman/options/4d_tech Unsub: mailto:[email protected] **********************************************************************
