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=-0.8 required=5.0 tests=BAYES_00,INVALID_DATE, MSGID_SHORT autolearn=no autolearn_force=no version=3.4.4 Xref: utzoo comp.software-eng:1140 comp.lang.ada:2052 Path: utzoo!attcan!uunet!mcvax!kth!enea!maxim!prc From: prc@maxim.ERBE.SE (Robert Claeson) Newsgroups: comp.software-eng,comp.lang.ada Subject: Re: comments on comments on comments Message-ID: <507@maxim.ERBE.SE> Date: 25 Feb 89 14:28:26 GMT References: <419@serene.UUCP> <4534@hubcap.UUCP> Organization: ERBE DATA AB List-Id: In article <4534@hubcap.UUCP>, billwolf@hubcap.clemson.edu (William Thomas Wolfe,2847,) writes: > I use a tactic which essentially makes comments as inherent a part > of the code as possible: I make all package, procedure, function, > type, and variable names as descriptive as reasonably possible. > > Examples: > > procedure POSITION_AT_LAST_ITEM (SOME_LINKED_LIST); I used to do that until I heard that the ANSI C standard will state that external identifiers should not be equal in the first six characters. Maybe POSIX says something else. I don't plan to port my code to anything else than POSIX (and maybe PC-DOS, if I have to). I also label each identifier with two to four characters that indentifies a package. For example, the functions in my package for handling double- linked lists in C has functions like "dlst_create_list" and "dlst_next_item". -- Robert Claeson, ERBE DATA AB, P.O. Box 77, S-175 22 Jarfalla, Sweden Tel: +46 (0)758-202 50 Fax: +46 (0)758-197 20 EUnet: rclaeson@ERBE.SE uucp: {uunet,enea}!erbe.se!rclaeson ARPAnet: rclaeson%ERBE.SE@uunet.UU.NET BITNET: rclaeson@ERBE.SE