3 ms·
i think this is still a half way house. code is documentation. bad source code is hard to read, or in practical terms - slow to read. good source code has mini
by jheriko 13y ago
i think this is still a half way house.
code is documentation. bad source code is hard to read, or in practical terms - slow to read. good source code has minimal comments and documentation.
writing documentation before you actually need it is often a waste of time as well. at this point surely you have a design to follow, or something other than a brainless application of 'documentation' to store that valuable information into?
as many commenters already point out what you almost always want is very high level documentation, and I think this should be present as a design (assuming you have one), if you don't have one then you need a wiki or something. Something that doesn't pollute your code with garbage...