Click here to Skip to main content
14,669,112 members
Home » Discussions » Work Issues
   

Work Issues

 
GeneralRe: Of Code and Comments Pin
David A. Gray5-Jul-17 16:02
MemberDavid A. Gray5-Jul-17 16:02 
GeneralRe: Of Code and Comments Pin
I.explore.code14-Jul-17 13:13
MemberI.explore.code14-Jul-17 13:13 
GeneralRe: Of Code and Comments Pin
Davie2124019-Feb-18 10:43
MemberDavie2124019-Feb-18 10:43 
AnswerRe: Of Code and Comments Pin
Foothill30-Jun-17 9:59
professionalFoothill30-Jun-17 9:59 
GeneralRe: Of Code and Comments Pin
David A. Gray30-Jun-17 10:30
MemberDavid A. Gray30-Jun-17 10:30 
AnswerRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 0:21
professionalEddy Vluggen1-Jul-17 0:21 
GeneralRe: Of Code and Comments Pin
I.explore.code1-Jul-17 6:50
MemberI.explore.code1-Jul-17 6:50 
GeneralRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 7:34
professionalEddy Vluggen1-Jul-17 7:34 
I.explore.code wrote:
What do you think about code comments though?
Mostly that there is no "perfect" approach Smile | :)

My personal code has few comments, mostly small sidenotes that are supposed to remind me whenever something might be different from my initial expectations.

At work, we do XML-documentation, mostly according to MS standard. It is verified during a build, and the build will fail if a public method is missing a documentation-tag for a parameter. There no single method is without documentation, and the source-code can be used to generate a MSDN-like overview of your classes and the (XML) comments. That in turn is very nice when going through a new codebase, trying to make sense of the code.

..as long as you don't include a useless header above an almost empty piece of code, I'm happy. (Try the C-Sharp IDE for a taste of that)

I.explore.code wrote:
They have hired me to help not only rearchitect the product to bring it into 21st century but also establish other practices like TDD, Scrum, CI/CD etc which they haven't really done in the past so its my job to shine a light on what needs to be done but they still seem to carry the paranoia
They have maintained the code, cared for it, and it clearly worked for them in the past, and here you come with all these changes Roll eyes | :rolleyes:

..does the rest of the team know of your mandate? Is the chief-architect actively supporting those changes? Can you explain how the new situation will be an improvement?
Bastard Programmer from Hell Suspicious | :suss:
If you can't read my code, try converting it here[^]

GeneralRe: Of Code and Comments Pin
I.explore.code1-Jul-17 9:14
MemberI.explore.code1-Jul-17 9:14 
GeneralRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 10:05
professionalEddy Vluggen1-Jul-17 10:05 
GeneralRe: Of Code and Comments Pin
I.explore.code1-Jul-17 13:33
MemberI.explore.code1-Jul-17 13:33 
GeneralRe: Of Code and Comments Pin
Eddy Vluggen1-Jul-17 23:27
professionalEddy Vluggen1-Jul-17 23:27 
GeneralRe: Of Code and Comments Pin
I.explore.code2-Jul-17 1:01
MemberI.explore.code2-Jul-17 1:01 
GeneralRe: Of Code and Comments Pin
maze327-Apr-18 4:52
professionalmaze327-Apr-18 4:52 
AnswerRe: Of Code and Comments Pin
imagiro4-Jul-17 21:51
Memberimagiro4-Jul-17 21:51 
GeneralRe: Of Code and Comments Pin
Ice Diamond21-Sep-17 22:53
professionalIce Diamond21-Sep-17 22:53 
AnswerRe: Of Code and Comments Pin
Richard Deeming5-Jul-17 7:57
mveRichard Deeming5-Jul-17 7:57 
AnswerRe: Of Code and Comments Pin
GuyThiebaut16-Oct-17 0:55
professionalGuyThiebaut16-Oct-17 0:55 
GeneralRe: Of Code and Comments Pin
den2k8816-Oct-17 3:28
professionalden2k8816-Oct-17 3:28 
GeneralRe: Of Code and Comments Pin
GuyThiebaut16-Oct-17 4:04
professionalGuyThiebaut16-Oct-17 4:04 
QuestionHTTP 403 Forbidden Error Pin
shanmugapriya rajendran19-Apr-17 15:10
Membershanmugapriya rajendran19-Apr-17 15:10 
AnswerRe: HTTP 403 Forbidden Error Pin
Vinod Jangle13-Jun-17 4:52
MemberVinod Jangle13-Jun-17 4:52 
QuestionWorking with Google Drive in WPF [Jason Gleim, 6 Mar 2013 ] Pin
Raja Chakraborty19-Apr-17 5:15
MemberRaja Chakraborty19-Apr-17 5:15 
AnswerRe: Working with Google Drive in WPF [Jason Gleim, 6 Mar 2013 ] Pin
ZurdoDev19-Apr-17 5:39
mveZurdoDev19-Apr-17 5:39 
QuestionJob search Pin
aterriba5-Apr-17 11:52
Memberaterriba5-Apr-17 11:52 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.