[Date Prev][Date Next][Thread Prev][Thread Next]
[Author Index]
[Date Index]
[Thread Index]
[SQR-USERS Info]
[SQRUG Home Page]
Re: [sqr-users] SQR Standards
- Subject: Re: [sqr-users] SQR Standards
- From: Robert Goshko <robert.goshko@gmail.com>
- Date: Mon, 21 Nov 2005 12:00:42 -0700
- Delivery-date: Mon, 21 Nov 2005 14:02:32 -0500
- Domainkey-signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com;h=received:message-id:date:from:to:subject:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references;b=RUTbiUO/gtcTrC/N0/0cX32nd6+95NuK/6GqO9BJ0jwyVdV90w/iA4tzJ7S5CVvADZgb8ZTJysS9yQJBQ5rUx+K8qOraBF/Tj021RecCzGbvMhNZ92EbduIk/TP3iAYGOLBWC4mtvJmNXwxLpWHx9/H2JPzvwVALAFm0vFzhVEo=
- In-reply-to: <E8629566E0BAC048A35B31BC78AF4C48019CC486@excmb01.backup>
- List-id: "This list is for discussion about the SQR database reportinglanguage from Hyperion Solutions." <sqr-users.sqrug.org>
- References: <E8629566E0BAC048A35B31BC78AF4C48019CC486@excmb01.backup>
On 21/11/05, Bob Stone <bstone@fastenal.com> wrote:
> I agree with everything Steve mentioned.
I second that as well
> The only thing I would add is that I find it visually useful to have comments
>at the beginning of each procedure explaining what it does, and that for each
>procedure in that SQR the comments are formatted the same. This allows
>someone to scroll down the program, and notice a) where one procedure ends and
>another starts, b) what a procedure does without digging into the logic for
>it. It allows a 2nd programmer to come in and see what a program does
>(underlying logic) without getting lost in the nitty-gritty of the code, or
>missing a procedure somewhere in the middle.
>
>
>
> !-----------------------------------------------------------------------!
> ! Procedure: Set-Route-to-PS-Vars !
> ! Desc: Procedure to set up variables needed in for the insert !
> ! to the DEP/DEP3 tables. !
> !-----------------------------------------------------------------------!
> begin-procedure Set-Route-to-PS-Vars
>
> ...
>
> end-procedure Set-Route-to-PS-Vars
I would try to keep this comment a little general because if it too
specific, after X number of revisions something may have gotten moved
and the comment not updated.
There are those that will tell you never to delete code, just comment
it out, I prefer to let a revision control system keep track of this
(RCS, PVCS, SourceSafe, etc), doesn't matter which one, just use one.
After a couple of years of maintenance, the source code starts to get
messy with thing being commented out and code added in.
--
...Rob
-- No trees were killed in the sending of this message. However a
large number of electrons were terribly inconvenienced.
================================================
Robert Goshko
Registered Linux User #260513
Want a Gmail account, 2.6+ GB web mail (for free), just ask me.
_______________________________________________
sqr-users mailing list
sqr-users@sqrug.org
http://www.sqrug.org/mailman/listinfo/sqr-users