Re: Comments in source code

2020-04-24 Thread flauenroth
Pretty much this. I am a huge supporter of "useful documentation" but over 90% of what I read either code, techbooks, manuals, the list goes on is written by people who donĀ“t know how to do it properly. OpenBSDs code is clean though as far as I can judge. I read through the whole thing simply

Re: Comments in source code

2020-04-23 Thread Chris Bennett
On Thu, Apr 23, 2020 at 05:38:40PM -0400, Aisha Tammy wrote: > Thanks a lot for responding, I've had some food so am feeling a lot less > frustrated :D > > > On 4/23/20 12:10 PM, Stuart Henderson wrote: > > > > It's often considered better if code is clear enough to stand by itself, > > keeping

Re: Comments in source code

2020-04-23 Thread Aisha Tammy
Thanks a lot for responding, I've had some food so am feeling a lot less frustrated :D > On 4/23/20 12:10 PM, Stuart Henderson wrote: > > It's often considered better if code is clear enough to stand by itself, > keeping comments for the less common cases which can't be figured out > from

Re: Comments in source code

2020-04-23 Thread Eric Furman
On Thu, Apr 23, 2020, at 5:38 PM, Aisha Tammy wrote: > > If you aren't already, you should be looking at commit messages from > > where the relevant code was touched. That is often where you'll find the > > explanations you seek. > > > I have been reading them, Commit messages don't explain

Re: Comments in source code

2020-04-23 Thread Stuart Henderson
On 2020-04-23, Aisha Tammy wrote: > Hey devs and all, > I'm kind of new to OpenBSD, only working on ports so far so take > what I say with chill. > I've been reading the source code in GIT and felt a real lack of comments > explaining what the code is doing. Is this something encouraged in