I got a request to add comments like below for each line of code we modify or write
What are your thoughts with pros and cons?
IF (StartDate = 0D) AND (NOT UseEmploymentDate) THEN
StartDate := WORKDATE; // If Start Date is Null and the user did not check Use EmploymentDate then use the Workdate
IF (StartDate > EndDate) AND (EndDate <> 0D) THEN
ERROR(error2); // If Start Date is After End Date and the End Date is not null then Error msg
*This post is locked for comments
Fully agree with Mouli kaku!
Even though CFMD also not required such a detail comments in code . If we write such comments in programming language then actual code will be hidden behind this comments. It will look like essay.
There are no pros unless they are expecting non-developers to read the code
I recently Attended Master Classes by Mark Brummel, According to him remove Green Stuff as much as you can and encourage Natural Language Programming. So instead of comments I will create a Local Function
replaceWorkDateIfnotUseEmployementDateandNull()
checkIfStartdateisgreaterthanEndDateandnotBlank()
So when you go to codeunit and try to collapse you can read what is going on in the codeunit.
Example
https://github.com/markbrummel/Master-Class-Examples/blob/master/Exercise%203/COD60003.TXT
Hi Mohana
It's a strange request as it might make the code harder to read with all the comments. Even so there is no point in writing a comment that tells you exactly what codes tells you anyway. I would rather put the reasoning - why is the part of the code run and what is achieved by that.
Robertas
#1
André Arnaud de Cal...
292,516
Super User 2025 Season 1
#2
Martin Dráb
231,409
Most Valuable Professional
#3
nmaenpaa
101,156
Share
Report
All responses (
Answers (
