Proper use of the Documentation() function?

JasonMaitlen · 2016-10-19

In customizing some of our objects and seeing how some of our third party apps document their code, I was wondering if there is a proper way to use the Documentation() function found in the C/AL code of objects. What I've been doing is adding something like this:

MYCOMPANY1.0    MyInitials     change made to the code
MYCOMPANY1.1    MyInitials     another change

For consistency I've been adding the same version (MYCOMPANY1.0) to the Version List field in the object designer. Even if there isn't code and we're simply adding a field, I document it in the Documentation() function. I've then been saving all of these objects off as text files and versioning them in Mercurial.

ishwarsharma016 · 2016-10-19

You're doing pretty good. I would suggest adding Date as well after your 'Initials'. This is would help in keeping track of when was a particular change made.

ishwarsharma016 · 2016-10-19

You're doing pretty good. I would suggest adding Date as well after your 'Initials'. This is would help in keeping track of when was a particular change made.

Kishorm · 2016-10-19

There is no official "proper way" of how to document in this trigger and what you have done is reasonable and gives a good audit of what changes have been made to the object. I'd say continue with what you are doing.

JasonMaitlen · 2016-10-20

Good call on the date, I'll add that. Thanks!

mohana_cse06 · 2016-10-21

Adding your name initials will also help you to identify who has done the change in future
like Jason Maitlen as JMA etc.

RockWithNAV · 2016-10-21

I believe the Proper Syntax should be something like this

Name - Date - DesignDocNo(If there is some Design doc no on the basis of which changes has been made) - A bit explanation of the code as why its been added including name of the Function if you made.

DenSter · 2016-10-25

There is no 'proper syntax' when it comes to the documentation trigger. There are even people who say don't document your code at all because that is what you use an ALM tool for. The key is to come up with what works for you and your organization, and to implement a standard way that you all do it.

Proper use of the Documentation() function?

Best Answer

Answers

Categories