From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=ham autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: 10ad19,23963231b5359f74 X-Google-Attributes: gid10ad19,public X-Google-Thread: 1073c2,23963231b5359f74 X-Google-Attributes: gid1073c2,public X-Google-Thread: 107a89,23963231b5359f74 X-Google-Attributes: gid107a89,public X-Google-Thread: 11440e,23963231b5359f74 X-Google-Attributes: gid11440e,public X-Google-Thread: 103376,23963231b5359f74 X-Google-Attributes: gid103376,public X-Google-Thread: 10a146,23963231b5359f74 X-Google-Attributes: gid10a146,public X-Google-Thread: 101deb,23963231b5359f74 X-Google-Attributes: gid101deb,public X-Google-ArrivalTime: 2001-06-06 14:32:50 PST Path: archiver1.google.com!newsfeed.google.com!sn-xit-03!sn-xit-02!sn-post-01!supernews.com!news.supernews.com!not-for-mail From: Pete Thompson Newsgroups: comp.lang.ruby,comp.lang.ada,comp.lang.awk,comp.lang.clarion,comp.lang.java.programmer,comp.lang.pl1,comp.lang.vrml Subject: Re: Long names are doom ? Date: Wed, 06 Jun 2001 14:19:02 -0700 Organization: Posted via Supernews, http://www.supernews.com Message-ID: <5u6thts9l1be5sa2v43ciefudrmof7s0ru@4ax.com> References: <9f2nks$ibd$0@dosa.alt.net> <3B177EF7.2A2470F4@facilnet.es> <9f8b7b$h0e$1@nh.pace.co.uk> <9f8r0i$lu3$1@nh.pace.co.uk> <9fgagu$6ae$1@nh.pace.co.uk> <9fjgha$blf$1@nh.pace.co.uk> <35mqhtkdfma2rggv1htcaq6vfn2ihs67a1@4ax.com> <3B1E1452.BAFAAB7F@baesystems.com> X-Newsreader: Forte Agent 1.8/32.548 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit X-Complaints-To: newsabuse@supernews.com Xref: archiver1.google.com comp.lang.ruby:10438 comp.lang.ada:8267 comp.lang.awk:2833 comp.lang.clarion:21249 comp.lang.java.programmer:74204 comp.lang.pl1:828 comp.lang.vrml:3569 Date: 2001-06-06T14:19:02-07:00 List-Id: On Wed, 06 Jun 2001 12:30:26 +0100, David Gillon wrote: >Explicit, readable coding has value even when being read by the most >experienced of software engineers. Consider the case of a safety >critical system under review by an external auditor prior to >certification. It's vital he be able to review the system in as thorough >a manner as possible in the time available, yet he may be completely new >to your coding standards and practices. The logic of a decision needs to >be clearly laid our for him, not something he needs to delve into the >musty depths of obscure documents for or to seek information on from the >original coder (especially if the original coder is in a substantially >different timezone). Equally, someone may have to fix your code twenty >years down the tracks, when the original coding team and the rationale >behind their decisions may have long since vanished (or walked in front >of a bus...). > >Explicit pays, maybe not now, maybe not directly, but in the end its a >worthwhile investment. Yes, I quite agree. The point I was trying to make is that there are varying levels of "explicitness" allowed in different industries. In your example, a critical system designed to last years, you'd be crazy to be non-explicit. However, if you're working in an industry where speed and optimization is king, then you sometimes simply don't have a choice and you're forced to write optimizations that may look cryptic. However, in such cases you should be sure to COMMENT it, and explain what it is and how it works. I think that people misunderstand me on one thing: I am not at all arguing against the use of comments. The code itself doesn't have to read like an essay if it's well commented. However, if I'm using a fairly standard API, then it's not up to me to write code that also teaches a newbie programmer how the API works. That's not my job. My job is to do my job, and to explain why and how I'm doing my job, not teach others how to code. If a newbie programmer has to read my code, then there are two requirements expected from him/her: know the language, and understand the API. I don't think this is too much to ask from any new programmers.