[R] writing comments within a function

[Hotz, T.]

> -----Original Message-----
> From: Ott Toomet [mailto:otoomet at econ.dk]
> Sent: 06 June 2003 12:05
> To: vincent.stoliaroff at socgen.com
> Cc: r-help at stat.math.ethz.ch
> Subject: Re: [R] writing comments within a function
> 
> 
>  | From: vincent.stoliaroff at socgen.com
>  | Date: Fri, 6 Jun 2003 11:57:32 +0200
> 
> Hallo,
> 
>  | Hi R lovers!
>  | 
>  | I would like to know how you can write comments inside the 
> code of a
>  | function
>  | 
>  | is it latex style
>  | % ?
>  | or any other language style?
> 
> It's #, otherwise like tex.  The same character is used by gnuplot and
> many configuration scripts and probably by many programming languages
> too.
> 
> You may also consider
> 
> if(FALSE) {
> ...
> }
> 
> But this "comment" must be syntactically correct.  You may also
> consider emacs+ESS which includes possibilities to commenting and
> uncommenting large program blocks.
> 
> I don't know where it is mentioned explicitly (I did not see it in "S
> Programming" (a book)), but most examples include comments, I guess.

It is stated in the "R Language Definition" manual, section 10.2, which 
usually comes with the distribution.

Best wishes

Thomas