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-Thread: 103376,8b756d9a0afb052a X-Google-Attributes: gid103376,public X-Google-Language: ENGLISH,ASCII-7-bit Newsgroups: comp.lang.ada Subject: Re: Quick question about Ada code formatting. References: <43F7915B.3090000@obry.net> <43F83D46.2090200@obry.net> <43F84890.7010900@obry.net> <43f871d8$0$491$9b4e6d93@newsread4.arcor-online.net> <43F872C4.50505@obry.net> From: Brian May Date: Mon, 20 Feb 2006 17:33:39 +1100 Message-ID: User-Agent: Gnus/5.1007 (Gnus v5.10.7) Emacs/21.4 (gnu/linux) Cancel-Lock: sha1:vLj9SzstmrJ01jushQ8vLslezFE= MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii NNTP-Posting-Host: snoopy.microcomaustralia.com.au X-Trace: news.melbourne.pipenetworks.com 1140417219 202.173.153.89 (20 Feb 2006 16:33:39 +1000) X-Complaints-To: abuse@pipenetworks.com X-Abuse-Info: Please forward all headers to enable your complaint to be properly processed. Path: g2news1.google.com!news2.google.com!news4.google.com!news.glorb.com!newsfeeds.ihug.co.nz!ihug.co.nz!news.xtra.co.nz!news-south.connect.com.au!duster.adelaide.on.net!news.melbourne.pipenetworks.com!not-for-mail Xref: g2news1.google.com comp.lang.ada:3005 Date: 2006-02-20T17:33:39+11:00 List-Id: >>>>> "Stephen" == Stephen Leake writes: >> ---------------------- >> -- Process_Whatever -- >> ---------------------- >> >> procedure Process_Whatever is >> ... >> >> Far clearer than 2 blank lines IMHO. Stephen> Yuck - a waste of valuable screen space. That's what Stephen> syntax colorization is for, along with navigation keys Stephen> (page forward goes to next subprogram). If you have long functions (yes, this might be pure evil in itself), then comments like the above help separate the different functions (even with good colour scheme this isn't always easy, especially if you have a lot of nested levels or even nested functions). However, the above is just asking for the comment to be expanded to clearly describe what on earth "Process_Whatever" does, and why it is different from the following procedures "Process_Whatever_2", "Princess_Whatever3", or "process_what_Ever_4". Stephen> Just my style, of course :). Just my experience. (yes; I do see some crazy names used in actual code, both open source and closed source, that leave you thinking you know what a subroutine/function does when you really don't) -- Brian May