Mathematica 9 is now available
Services & Resources / Wolfram Forums
-----
 /
MathGroup Archive
2007
*January
*February
*March
*April
*May
*June
*July
*August
*September
*October
*Archive Index
*Ask about this page
*Print this page
*Give us feedback
*Sign up for the Wolfram Insider

MathGroup Archive 2007

[Date Index] [Thread Index] [Author Index]

Search the Archive

RE: RE: simple question

  • To: mathgroup at smc.vnet.net
  • Subject: [mg77161] RE: [mg77113] RE: [mg77099] simple question
  • From: "Ingolf Dahl" <ingolf.dahl at telia.com>
  • Date: Tue, 5 Jun 2007 06:35:19 -0400 (EDT)
  • References: <200706031015.GAA03008@smc.vnet.net> <17807603.1180947440083.JavaMail.root@m35> <op.ttd8jwb7qu6oor@monster.ma.dl.cox.net>

Yes, from execution point of view, 

"This is my comment." 

works as well as 

Comment[" This is my comment. "]; 

but comments are meant for human readers of the program, and I think that my
proposal is better for informing the reader that the comment really is a
comment and nothing else. It is also easier for a metaprogram to find,
delete, print, color or translate all such comments inside a program.
Another way is of course to decorate the comment strings in some way, for
instance

"(***** This is my comment. *****)" .

Matter of taste...
About not capitalizing user-defined functions, I think that that is a good
rule, if some exceptions are allowed. For instance, package authors usually
seem to capitalize their "user-defined" functions. And if I suggest this
natural use of the word "Comment", it is implicitly an appeal to Wolfram not
to use the same word for something else. If many users adopted the practice,
they could even include it as an alternative in the Help.

Best regards

Ingolf Dahl

> -----Original Message-----
> From: DrMajorBob [mailto:drmajorbob at bigfoot.com] 
> Sent: den 4 juni 2007 12:54
> To: Ingolf Dahl; mathgroup at smc.vnet.net
> Subject: Re: [mg77113] RE: [mg77099] simple question
> 
> I believe "This is my comment." works just as well, without 
> the comment function. (I never capitalize user-defined functions.)
> 
> Bobby
> 
> On Mon, 04 Jun 2007 02:46:35 -0500, Ingolf Dahl 
> <ingolf.dahl at telia.com>
> wrote:
> 
> > Hi Dimitris,
> > I cite from mg64218 (Feb 7, 2006), thread "Notebooks, 
> packages, cells, 
> > and literate programming":
> >
> > "One alternative way to enter inline comments, if you anyway want 
> > that, is to wrap them up in a ordinary Mathematica function in this 
> > way:
> >
> > Comment[" This is my comment. "];
> >
> > There usually are any number of places in the code where 
> you could add 
> > comments in this way. If you have not defined the function Comment, 
> > the statement will not be evaluated. Such comments are not 
> removed by 
> > Shift-Ctrl-N or Shift-Ctrl-I.
> > Of course I must here also remind that the button 
> "CopyAsInputForm" in 
> > my SetFaceAndFont Palette preserves (* *) comments by 
> converting them 
> > into the suggested alternative. (See 
> > http://web.telia.com/~u31815170/Mathematica/)"
> >
> > The palette is not updated to version 6 yet, since I just have had 
> > Mathematica 6 available a few days, but this feature seems to be 
> > functioning.
> >
> > Best regards
> >
> > Ingolf Dahl
> >
> >> -----Original Message-----
> >> From: dimitris [mailto:dimmechan at yahoo.com]
> >> Sent: den 3 juni 2007 12:15
> >> To: mathgroup at smc.vnet.net
> >> Subject: [mg77099] simple question
> >>
> >> Hi.
> >>
> >> I have a simple question but I can't find any relevant.
> >> Suppose a user-defined function with comments [that is
> >> (*...*) structures] added.
> >>
> >> Let for example
> >>
> >> \!\(Nint[g_ (*function*) , n_Integer, {x_, a_, b_} (*
> >>       the\ variable\ and\ the\ limits\
> >>         of\ integration*) , opts___ (*set\ possible\ 
> options\ for\ \
> >> NIntegrate*) ] := NIntegrate[Evaluate[g\^Range[n]], {x, a, b}, 
> >> opts]\)
> >>
> >> The code has been copy/paste in StandardForm.
> >> Let me convert it to InputForm. After selecting the cell and press 
> >> Shift+Ctrl+I, I get
> >>
> >> In[1]:=
> >> Nint[g_, n_Integer, {x_, a_, b_}, opts___] := 
> >> NIntegrate[Evaluate[g^Range[n]], {x, a, b}, opts]
> >>
> >> That is, the comments during the conversion have been lost.
> >>
> >> Any ideas to "fix" this situation?
> >>
> >> Dimitris
> >>
> >>
> >>
> >
> >
> >
> >
> 
> 
> 
> --
> DrMajorBob at bigfoot.com




  • Prev by Date: Re: MakeExpression problem
  • Next by Date: Re: Two Version 6.0 Package Problems
  • Previous by thread: Re: RE: simple question
  • Next by thread: Re: RE: RE: simple question