You are not logged in. Your edit will be placed in a queue until it is peer reviewed.
We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.
- 1@FreshDaddy. "They (for the most part) won't ever see private functions." False. After you win the lottery, other programmers will take over your code and see the private functions. Also. Some languages (e.g. Python) eschew this kind of privacy.S.Lott– S.Lott2011-09-06 18:16:18 +00:00Commented Sep 6, 2011 at 18:16
- 2@S.Lott - Listing every private function is not a common requirement at all. It happens, don't get me wrong, but a full-scale "list every private function before writing code" is certainly pretty rare. There is "necessary tedius" and then there is "worthless tedius". Considering programmers are in the business of eliminating "worthless tedius", real world clients would hardly ever request something as costly and pointless as this, unless it was "life or death" type code.user3792– user37922011-09-06 18:28:15 +00:00Commented Sep 6, 2011 at 18:28
- 1@ironcode: '"list every private function before writing code" is certainly pretty rare.' Not in my experience. It's how people learn to do design. Junior programmers are often held to this standard until they can prove that their work doesn't require this level of oversight. Generally less than a year. An organization that took n00bs from school and threw them at programming with no oversight is mostly just creating huge problems. This level of oversight is essential to be sure that code has a fighting chance of working.S.Lott– S.Lott2011-09-06 18:48:29 +00:00Commented Sep 6, 2011 at 18:48
- 1@S Lott - my motto is that if software development is tedious, you are doing it wrong. We're programmers. We automate the tedium. We don't repeat ourselves in code, and there is no reason to repeat ourselves in the documentation either.kevin cline– kevin cline2011-09-07 02:41:24 +00:00Commented Sep 7, 2011 at 2:41
- 1@kevin: this answer is pure sarcasm. As such, it is completely inappropriate, and I've flagged it.Michael Borgwardt– Michael Borgwardt2011-09-07 08:24:10 +00:00Commented Sep 7, 2011 at 8:24
| Show 13 more comments
How to Edit
- Correct minor typos or mistakes
- Clarify meaning without changing it
- Add related resources or links
- Always respect the author’s intent
- Don’t use edits to reply to the author
How to Format
- create code fences with backticks ` or tildes ~ ```
like so
``` - add language identifier to highlight code ```python
def function(foo):
print(foo)
``` - put returns between paragraphs
- for linebreak add 2 spaces at end
- _italic_ or **bold**
- indent code by 4 spaces
- backtick escapes
`like _so_` - quote by placing > at start of line
- to make links (use https whenever possible) <https://example.com>[example](https://example.com)<a href="https://example.com">example</a>
How to Tag
A tag is a keyword or label that categorizes your question with other, similar questions. Choose one or more (up to 5) tags that will help answerers to find and interpret your question.
- complete the sentence: my question is about...
- use tags that describe things or concepts that are essential, not incidental to your question
- favor using existing popular tags
- read the descriptions that appear below the tag
If your question is primarily about a topic for which you can't find a tag:
- combine multiple words into single-words with hyphens (e.g. design-patterns), up to a maximum of 35 characters
- creating new tags is a privilege; if you can't yet create a tag you need, then post this question without it, then ask the community to create it for you