Standards for Inline Documentation in navison? //

Hello, 

I'm a brandnew Navision Engineer and i am struggling alot with the amount of inline documentation i find in the code from older Navision Engineers!

What are the unwritten standards for Inline documentation in navision? Whenever i work in someones custom method's i'm having a hard time figuring out what it does! While one or 2 lines of inline documentation would safe me alot of time !

This also goes for custom Codeunit's is there nowhere where the developer writes where the codeunit is for or what it is supposed to do?

Thank's in advance!

Greetings,


Daan Brandt

REMINDER: "Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live"  ― John Woods

Parents
  • I guess I am evil, because I love comments, and even essential for tracking changes in the code. Whenever a change is made, it is connected to a task (or work item if you're using TFS). This task is tracked somewhere, and it usually has a number. I like to see that number in the documentation trigger, with the date and developer initials, and then the code change itself documented in line with the same number. The reason is that I want to be able to quickly jump to the change in the code, and without comments it is impossible to do this. Especially in objects that have large amounts of code this saves a lot of time trying to figure out issues.

    So let's say I am working on change ABC123, I'd have a comment in the doc trigger something like "ABC123 - DR - Aug 23, 2016 - short description". Then in the code I'd have the 'ABC123' reference as well, as a pointer to the code that I changed. I can copy the ABC123 number and use Ctrl+F to jump to all instances of the number in the code.

    Now, a source control system gives you the changes linked to the work items, but I want to be able to quickly jump to the code inside the object itself. I have to admit, we are not yet using source control, so I might change my mind, but I don't think I would want to give up the ability to search for specific changes inside the code itself as I am troubleshooting an issue.
Reply Children
No Data
Related
Recommended