harborsparrow's latest activity
-
harborsparrow reacted to DaveC426913's post in the thread Documentation of (only) source code with
Agree.
If the comments are sufficently succinct and well thought out, they will need updating less, if ever. (A function will generally not... -
harborsparrow reacted to DaveC426913's post in the thread Documentation of (only) source code with Agree.
I was going to bring that up. Glad someone did. Now you've got lines and lines of pseudocode that does not match what the code is...
-
harborsparrow reacted to jedishrfu's post in the thread Documentation of (only) source code with
Like.
Another point against pseudo code is updates. Often programmers fix a defect and comment about what was wrong and how they fixed it... -
harborsparrow reacted to FactChecker's post in the thread Documentation of (only) source code with Like.
IMO, pseudocode does not necessarily serve the purpose of good documentation. I don't know if there is an official, enforced...
-
harborsparrow reacted to DaveC426913's post in the thread Documentation of (only) source code with Like.
We had a rule that THOU SHALT NOT COMMIT ANYTHING THAT BREAKS THE BUILD. The punishment was to be handed a scraper and have a go at...
-
harborsparrow reacted to phyzguy's post in the thread Documentation of (only) source code with Like.
I strongly agree with the importance of unit tests. But there is more to it than that. I have had cases where the code writer said...
-
harborsparrow reacted to FactChecker's post in the thread Documentation of (only) source code with
Sad.
I once had the job of integrating and testing code inputs from several engineers into flight critical code. I remember one time when a... -
harborsparrow reacted to Baluncore's post in the thread Documentation of (only) source code with Like.
A similar thing happens to me here at PF. After a couple of years, I get a reply notification to a watched thread, and so read back up...
-
harborsparrow reacted to FactChecker's post in the thread Documentation of (only) source code with
Love.
I have had occasions where I was looking at someone's old code, trying to figure it out so that I could modify it, drawing all sorts of... -
harborsparrow reacted to Baluncore's post in the thread Documentation of (only) source code with Like.
I only write very low-level and compact code, so I leave myself notes addressed like "We need to ...", because I will have forgotten...
-
harborsparrow reacted to phyzguy's post in the thread Documentation of (only) source code with Like.
I've found that when I'm documenting my code, one of the main people I'm writing the documentation for is me. So that when I come back...
-
harborsparrow reacted to Filip Larsen's post in the thread Documentation of (only) source code with Like.
There are a lot of coding guidelines and principles floating around, some probably also contradicting each other or of varying relevance...
-
harborsparrow reacted to elias001's post in the thread Documentation of (only) source code with Love.
@FactChecker and @Filip Larsen well I have an idea, for every 1000 lines of code in whatever you are writing, you will force whoever...
-
harborsparrow reacted to Filip Larsen's post in the thread Documentation of (only) source code with Like.
I am not sure if you say this because you think pseudo-code somehow magically can elucidate details that code in a modern language...
-
harborsparrow reacted to FactChecker's post in the thread Documentation of (only) source code with Like.
Good question. Pseudocode can be as obscure as the real code, so that is not the right way to describe good documentation. There are...