Click here to Skip to main content
15,513,125 members

Welcome to the Lounge

   

For discussing anything related to a software developer's life but is not for programming questions. Got a programming question?

The Lounge is rated Safe For Work. If you're about to post something inappropriate for a shared office environment, then don't post it. No ads, no abuse, and no programming questions. Trolling, (political, climate, religious or whatever) will result in your account being removed.

 
GeneralRe: Comparisons Pin
David O'Neil22-May-22 10:43
professionalDavid O'Neil22-May-22 10:43 
QuestionImportance of Documentation Pin
Richard Andrew x6421-May-22 15:41
professionalRichard Andrew x6421-May-22 15:41 
AnswerRe: Importance of Documentation Pin
Mircea Neacsu21-May-22 16:41
mvaMircea Neacsu21-May-22 16:41 
GeneralRe: Importance of Documentation Pin
Richard Andrew x6421-May-22 17:09
professionalRichard Andrew x6421-May-22 17:09 
GeneralRe: Importance of Documentation Pin
Mircea Neacsu21-May-22 17:37
mvaMircea Neacsu21-May-22 17:37 
AnswerRe: Importance of Documentation Pin
Jacquers21-May-22 20:27
Jacquers21-May-22 20:27 
AnswerRe: Importance of Documentation Pin
RickZeeland21-May-22 23:32
mveRickZeeland21-May-22 23:32 
AnswerRe: Importance of Documentation Pin
Daniel Pfeffer22-May-22 1:04
professionalDaniel Pfeffer22-May-22 1:04 
Such undocumented code is, unfortunately, more the rule than the exception.

The only thing I can suggest is that as code is modified (maintained / upgraded), you write comments in the code describing what the code does and why. Even a comment header may be useful for those who must follow after you.

I realize that some code bases require that changes be minimal and address only the required change. In that case, you should provide an external document (ensuring that everyone knows where it is), and write your observations in there. This is less ideal that in-place documentation, but will ensure that whatever information you recovered from your colleagues will be there for "future generations".
Freedom is the freedom to say that two plus two make four. If that is granted, all else follows.
-- 6079 Smith W.

AnswerRe: Importance of Documentation Pin
Sander Rossel22-May-22 3:22
professionalSander Rossel22-May-22 3:22 
GeneralRe: Importance of Documentation Pin
Mircea Neacsu23-May-22 10:03
mvaMircea Neacsu23-May-22 10:03 
GeneralRe: Importance of Documentation Pin
Sander Rossel24-May-22 1:47
professionalSander Rossel24-May-22 1:47 
AnswerRe: Importance of Documentation Pin
trønderen22-May-22 7:19
trønderen22-May-22 7:19 
AnswerRe: Importance of Documentation Pin
PhilipOakley22-May-22 23:36
professionalPhilipOakley22-May-22 23:36 
AnswerRe: Importance of Documentation Pin
Cpichols23-May-22 3:20
Cpichols23-May-22 3:20 
GeneralRe: Importance of Documentation Pin
MarkTJohnson23-May-22 3:52
professionalMarkTJohnson23-May-22 3:52 
GeneralRe: Importance of Documentation Pin
Cpichols23-May-22 4:03
Cpichols23-May-22 4:03 
AnswerRe: Importance of Documentation Pin
RussellT23-May-22 4:03
professionalRussellT23-May-22 4:03 
AnswerRe: Importance of Documentation Pin
Matt Bond23-May-22 6:28
Matt Bond23-May-22 6:28 
AnswerRe: Importance of Documentation Pin
NightPen23-May-22 6:43
NightPen23-May-22 6:43 
GeneralRe: Importance of Documentation Pin
RussellT23-May-22 12:33
professionalRussellT23-May-22 12:33 
GeneralRe: Importance of Documentation Pin
NightPen23-May-22 16:09
NightPen23-May-22 16:09 
AnswerRe: Importance of Documentation Pin
pmauriks23-May-22 19:24
pmauriks23-May-22 19:24 
GeneralHave a good funky weekend ;) Pin
0x01AA21-May-22 9:24
professional0x01AA21-May-22 9:24 
GeneralRe: Have a good funky weekend ;) Pin
Sander Rossel22-May-22 3:49
professionalSander Rossel22-May-22 3:49 
GeneralThe world's leading expert on European wasps walks into a record shop. Pin
OriginalGriff21-May-22 9:16
mveOriginalGriff21-May-22 9:16 

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.


Straw Poll

An amazing AI programming tool is invented that can do one task perfectly. What would you choose?
  Results   628 votes