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,FREEMAIL_FROM autolearn=ham autolearn_force=no version=3.4.4 X-Google-Thread: a07f3367d7,429176cb92b1b825 X-Google-Attributes: gida07f3367d7,public,usenet X-Google-NewGroupId: yes X-Google-Language: ENGLISH,UTF8 Path: g2news2.google.com!news3.google.com!feeder.news-service.com!94.75.214.39.MISMATCH!aioe.org!not-for-mail From: =?utf-8?Q?Yannick_Duch=C3=AAne_=28Hibou57?= =?utf-8?Q?=29?= Newsgroups: comp.lang.ada Subject: Re: AWS Coding Styles (and about boring plain-linear text files in the end) Date: Wed, 19 Jan 2011 02:06:42 +0100 Organization: Ada @ Home Message-ID: References: <24418fa4-8843-4fe6-8c2f-026ea6009b68@g26g2000vbz.googlegroups.com> <87lj2ido9j.fsf@mid.deneb.enyo.de> <4D35F6C8.2060100@obry.net> <4d3608ab$0$7664$9b4e6d93@newsspool1.arcor-online.net> <4d3634a5$0$7664$9b4e6d93@newsspool1.arcor-online.net> NNTP-Posting-Host: 59xjXE7stDARAmb8zI1USw.user.speranza.aioe.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed; delsp=yes Content-Transfer-Encoding: Quoted-Printable X-Complaints-To: abuse@aioe.org X-Notice: Filtered by postfilter v. 0.8.2 User-Agent: Opera Mail/11.00 (Win32) Xref: g2news2.google.com comp.lang.ada:17511 Date: 2011-01-19T02:06:42+01:00 List-Id: Le Wed, 19 Jan 2011 01:47:33 +0100, Georg Bauhaus = a =C3=A9crit: > My guess was similar. When names will need to be changed, > the comments can otherwise stay intact: > > procedure Call (Filename : String); > -- Filename must be an abosulute name > > becomes > > procedure Call (Path : String); > -- Path must be an abosulute name > > (I am not suggesting that Path is better than Filename.) > However, when the name becomes "Frmbloo", as in > > procedure Call (Frmbloo : String); > -- Frmbloo must be an abosulute name > > the comment shows that it does depend on the names of things: > The "file" part has gone missing, leaving a blank that the reader > cannot fill in by inference from either the name or from the comment. > What is a Frmbloo? > > The comment specifically mentions the formal argument name, > as should be. However, the comment does depend on the name of > things. So this turn to be a suggestion about the good way to name program = elements ? If a name is natural enough, it appears similarly naturally i= n = comments and is less likely to be changed, so less likely to become a = matter about broken sync between comment and source. By the way, to talk about these particular identifiers, the File_Name vs= = Path is troublesome to me. From source to source in multiple places, the= = definition of a file name seems to vary: sometime the file base name + = file extension, without directory, sometime the directory to which is = appended the file base name and extension. I feel this should always be = = file base name + extension without directory, so that you may have = Directory_Name the same way there may be File_Name, and Entry_Name when = = the type is unknown (either file or directory). -- = Si les chats miaulent et font autant de vocalises bizarres, c=E2=80=99es= t pas pour = les chiens. =E2=80=9CI am fluent in ASCII=E2=80=9D [Warren 2010]