Talk:Coding best practices: Difference between revisions

Content deleted Content added
Peer Review?
Scoaldr (talk | contribs)
Removal: Reply
 
(30 intermediate revisions by 19 users not shown)
Line 1:
{{WikiProject banner shell|class=C|
{{WikiProject Computing |science=y |science-importance=Mid |software=y |software-importance=High |importance=Low |security=y |security-importance=Low}}
}}
 
==Old comment==
 
The article is full of sweeping generalizations, non-sequturs, and contoversial advice presented as fact.
It is amusing that it is accidentally correct in saying that the practices described have "incredible" (i.e not credible) value.
 
This page gets into lifecycle, requirements, etc. best practices. But the title is *Coding* best practices.
 
Also, many of the best practices listed for requirements, architecture, etc. aren't necessarily best practices. For example, Extreme Programming disagrees with them, yet is a very valid methodology. [[User:DRogers|DRogers]] 17:11, 12 September 2006 (UTC)
 
 
== Criticism of Article content and tone. ==
Line 36 ⟶ 46:
== Peer Review ==
Article seems to suggest that Peer Review means looking at other people's code to see what's the best way to do things. That's not what peer review means at all. Rather it means having other people look at your work, to identify any problems in your own code. --[[User:Duncancumming|duncan]] ([[User talk:Duncancumming|talk]]) 09:48, 10 February 2009 (UTC)
 
== Unclear article ==
 
This article is in serious need of a cleanup. As it stands, it is incomplete, suggestive and even misleading. I'd almost prefer it to be deleted as it requires complete rewrite anyway. -- [[User:Mafutrct|mafutrct]] ([[User talk:Mafutrct|talk]]) 13:57, 11 November 2009 (UTC)
 
== Rewrite ==
 
This article is badly written and off topic. I was looking for a conclustion to coding dilema myself but will have a go at rewriting this article instead.
 
The title "Coding Practices" would be more appropriate with a section on "Best coding practices".
 
This article currently seems to be a vague, inaccurate, inexperienced and personal view on project development.
 
This article should really be covering the use of comments and layouts in code, naming convention of variables, methods etc, use of switches/ifs, the differences these changes have in a range of languages and the choices to be made based on the situation in hand. [[User:SkeaterMedia|SkeaterMedia]] ([[User talk:SkeaterMedia|talk]]) 07:16, 22 April 2010 (UTC)
 
The article contains no mention of logging or use of libraries, both of which I consider crucial coding practices.
[[User:Bartonski|Bartonski]] ([[User talk:Bartonski|talk]]) 06:20, 1 January 2013 (UTC)
 
== Rewrite ==
 
I have started rewriting this article, taking note of the various criticisms mentioned above. I fully intend to include lots of inline references.
 
Please check my work, add more references, etc. as I progress. [[User:Murray Langton|Murray Langton]] ([[User talk:Murray Langton|talk]]) 19:24, 30 October 2013 (UTC)
 
:Well, some progress has been made:
:* Rearrangement of topics to provide a more logical grouping.
:* Rewrite of first two sections (Software quality, Prerequisites), with a fair number of quotes and inline references.
 
:The remaining sections have still to be considered. Any suggestions for this or for sections not yet mentioned are welcome. [[User:Murray Langton|Murray Langton]] ([[User talk:Murray Langton|talk]]) 22:30, 7 November 2013 (UTC)
 
== Removal ==
 
This article is a farce. It just needs to be deleted, not rewritten. There's absolutely no need for an article entitled "best coding practices" in an encyclopedia. Even the title is a joke. Please delete this embarrasment of an article. <span style="font-size: smaller;" class="autosigned">— Preceding [[Wikipedia:Signatures|unsigned]] comment added by [[Special:Contributions/82.9.176.129|82.9.176.129]] ([[User talk:82.9.176.129|talk]]) 17:23, 5 February 2014 (UTC)</span><!-- Template:Unsigned IP --> <!--Autosigned by SineBot-->
 
: Somewhat agree, there no new ideas. There too many outside links. Also there better written and maintained page on almost same topic: [[Software quality]] [[User:Ushkin N|Ushkin N]] ([[User talk:Ushkin N|talk]]) 07:38, 23 May 2016 (UTC)
:Agree, this feels like a blogpost.[[User:Scoaldr|Scoaldr]] ([[User talk:Scoaldr|talk]]) 05:40, 12 August 2024 (UTC)
 
== Assertions ==
There is no discussion of the use of assertions. Assertions are a really useful tool to help debug programs. For example, at the JPL, one of their coding rules is that a certain percentage of the lines of code (I think about 8%) have to be assertions. It's easy to find a reference for that. <small class="autosigned">—&nbsp;Preceding [[Wikipedia:Signatures|unsigned]] comment added by [[Special:Contributions/2601:280:4201:D47F:D45E:D915:C74:3BF2|2601:280:4201:D47F:D45E:D915:C74:3BF2]] ([[User talk:2601:280:4201:D47F:D45E:D915:C74:3BF2|talk]]) 17:06, 18 August 2015 (UTC)</small><!-- Template:Unsigned IP --> <!--Autosigned by SineBot-->
 
== version control? ==
 
is it appropriate to mention version control here? <!-- Template:Unsigned IP --><small class="autosigned">—&nbsp;Preceding [[Wikipedia:Signatures|unsigned]] comment added by [[Special:Contributions/2605:E000:308B:1E00:CC09:4A50:74D5:AAA3|2605:E000:308B:1E00:CC09:4A50:74D5:AAA3]] ([[User talk:2605:E000:308B:1E00:CC09:4A50:74D5:AAA3|talk]]) 07:49, 30 June 2016 (UTC)</small> <!--Autosigned by SineBot-->
: Hi, it is, as part of https://en.wikipedia.org/wiki/Best_coding_practices#Deployment or configuration management (versions and variants){{Resolved}}--[[User:17387349L8764|𝔏92934923525]] ([[User talk:17387349L8764|talk]]) 00:52, 22 February 2021 (UTC)
 
== External links modified ==
 
Hello fellow Wikipedians,
 
I have just modified one external link on [[Best coding practices]]. Please take a moment to review [https://en.wikipedia.org/w/index.php?diff=prev&oldid=791232372 my edit]. If you have any questions, or need the bot to ignore the links, or the page altogether, please visit [[User:Cyberpower678/FaQs#InternetArchiveBot|this simple FaQ]] for additional information. I made the following changes:
*Added {{tlx|dead link}} tag to http://delivery.acm.org/10.1145/360000/358561/p75-hoare.pdf?ip=86.149.222.132&id=358561&acc=OPEN&key=BF13D071DEA4D3F3B0AA4BA89B4BCA5B&CFID=376760624&CFTOKEN=68991969&__acm__=1383824348_7b82781d1f57e0bdc065e0717663d1c3
*Added archive https://web.archive.org/web/20090713030558/http://www.ibm.com/developerworks/aix/library/au-hook_duttaC.html to http://www.ibm.com/developerworks/aix/library/au-hook_duttaC.html
 
When you have finished reviewing my changes, you may follow the instructions on the template below to fix any issues with the URLs.
 
{{sourcecheck|checked=false|needhelp=}}
 
Cheers.—[[User:InternetArchiveBot|'''<span style="color:darkgrey;font-family:monospace">InternetArchiveBot</span>''']] <span style="color:green;font-family:Rockwell">([[User talk:InternetArchiveBot|Report bug]])</span> 23:35, 18 July 2017 (UTC)