Argus Productions Inc.

Getting the developers to document the code they write is a challenge. In past articles we have discussed how Argus Development Tools helps you know what is done and what is not done.

The Argus Development Tool includes a Documentation tool. This is code written in 4D. The developers place some code at the start of each method. This code is all part of the items needed for the rest of Argus Development Tools needs. Change some items to indicate the function names, and a description. Developers get to work in code. They do not need to think about formatting, appearance, fonts, font size etc. That is all handled for them.

They can then choose to generate the documentation right there. The documentation for the method is generated right on screen and displayed in their chosen Mark Up Language editor. In my case Typora.

They can look over the clear, standard formatted documentation to ensure it is correct. If there is a mistake, or something missing, just add it into the code.

When the documentation is generated it is automatically placed in the correct folder in 4D. Therefore when multiple developers are using GIT, they automatically get all the nicely formatted documentation for all the methods from all the developers.

Here is an example of Documentation for a method: