3 ms·
> Why not just preface every line with that? Because that's noise that makes reading the code more difficult. Creating a separate markup file that provides com
by Supermancho 5y ago
> Why not just preface every line with that?
Because that's noise that makes reading the code more difficult.
Creating a separate markup file that provides comments (even overlapping) that are associated to files and lines, for display in an IDE window seems like the logical way to go from the current style of inlining comments into code.
- emodendroket 5y agoI have my doubts. It seems like that would be even more likely to drift than inline comments.
- Supermancho 5y ago> It seems like that would be even more likely to drift than inline comments. I'm not sure why that matters to utility. If you don't check the documentation/comments and code in a changeset, you are going to get drift. This is regardless of the documentation methodology. How poorly developers maintain code is a constant in the case of drift (lack of rigor), so the method is irrelevant, except in how descriptive it can be. A complex application is a nested logical structure tied to orthogonal business requirements. This is why READMEs and docs folders exist, alongside large block comments, hidden amongst the code. How to best describe code is definitely not to inline it, as that's too limiting for what is to be described.