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.3 required=5.0 tests=BAYES_00,INVALID_MSGID autolearn=no autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: fac41,af40e09e753872c X-Google-Attributes: gidfac41,public X-Google-Thread: 109fba,f292779560fb8442 X-Google-Attributes: gid109fba,public X-Google-Thread: f8c65,30e368bdb3310fe5 X-Google-Attributes: gidf8c65,public X-Google-Thread: 1014db,30e368bdb3310fe5 X-Google-Attributes: gid1014db,public X-Google-Thread: 10db24,30e368bdb3310fe5 X-Google-Attributes: gid10db24,public X-Google-Thread: 1008e3,30e368bdb3310fe5 X-Google-Attributes: gid1008e3,public X-Google-Thread: 103376,30e368bdb3310fe5 X-Google-Attributes: gid103376,public From: tangent@cyberport.com (Warren Young) Subject: Re: Hungarian notation Date: 1996/06/03 Message-ID: <31b2c276.447844676@news.cyberport.com>#1/1 X-Deja-AN: 158229214 references: <31999F43.41C67EA6@scn.de> <4o07o9$rfu@seagoon.newcastle.edu.au> <4o1vo3$p2a@news1.ni.net> <4oehnp$onn@goanna.cs.rmit.EDU.AU> <4omejm$j3a@goanna.cs.rmit.EDU.AU> <31b07448.390945509@sqarc.sq.com> organization: none newsgroups: comp.lang.ada,comp.lang.c++,comp.lang.c,comp.lang.modula3,comp.lang.modula2,comp.edu,comp.lang.eiffel Date: 1996-06-03T00:00:00+00:00 List-Id: willer@carolian.com (Steve Willer) wrote: >ok@goanna.cs.rmit.EDU.AU (Richard A. O'Keefe) wrote: > >>me to a term I didn't know: "callout" (basically, you have a diagram >>and a legend and a line that connects the legend to the place in the >>diagram it comments on). > >This sounds interesting, but I don't really understand what you mean >here. Could you give an example of this? You see them all the time. They come in several flavors, but they basically all have a line pointing to something, and then a more detailed description or whatever at the end of the line. You see it in drawing labels, "detail views", and drawing comments. If you've read Design Patterns, you have seen a form of callouts in its pseudocode notation. Naturally, this is all very graphical in nature, and just about impossible to reproduce in a textual medium. So, if you're writing a book, you might have time to do this sort of thing, but if you're hacking out some example code for your students, you probably don't. So, I proposed using special comments to visually differentiate explanatory comments from normal comments. You might do something like this: // Do [something] with the devices //! Note that the for loop runs from 0 to one less than the //! number of devices available. for (x = 0; x < kNumDevices; x++) { ... Notice the //! notation for introducing explanatory comments. It's easier than callouts, though it isn't as pretty. = Warren -- http://www.cyberport.com/~tangent