# Rake appdoc Question regarding comment formatting

**URL:** <https://www.ruby-forum.com/t/rake-appdoc-question-regarding-comment-formatting/59273>\
**Category:** Rails\
**Created:** [May 3, 2006, 3:07am UTC](https://www.ruby-forum.com/t/rake-appdoc-question-regarding-comment-formatting/59273 "2006-05-03T03:07:20Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![aginghipster](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/e9c0ed/32.png) [@aginghipster](https://www.ruby-forum.com/u/aginghipster)\
**Post date:** [May 3, 2006, 3:07am UTC](https://www.ruby-forum.com/t/rake-appdoc-question-regarding-comment-formatting/59273/1 "2006-05-03T03:07:20Z")

</div>

I tried googling and searching the forums here but was unable to locate  
an answer, please forgive if this has been covered.

Is there any way to provide formatting guidelines to dictate how parsed  
comments are displayed in the resulting html? In the simplest example,  
is there a way to specify a linebreak (break tag)?

Thanks,  
Andy

---

<div class="post-metadata">

**Author:** ![aginghipster](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/e9c0ed/32.png) [@aginghipster](https://www.ruby-forum.com/u/aginghipster)\
**Post date:** [May 3, 2006, 7:38am UTC](https://www.ruby-forum.com/t/rake-appdoc-question-regarding-comment-formatting/59273/2 "2006-05-03T07:38:43Z")

</div>

Google: ‘rdoc format’

Here’s a link that should help.

[http://rdoc.sourceforge.net/doc/files/README.html](http://rdoc.sourceforge.net/doc/files/README.html)

Andrew C. wrote:

> I tried googling and searching the forums here but was unable to locate  
> an answer, please forgive if this has been covered.
> 
> Is there any way to provide formatting guidelines to dictate how parsed  
> comments are displayed in the resulting html? In the simplest example,  
> is there a way to specify a linebreak (break tag)?
> 
> Thanks,  
> Andy

---

<div class="post-metadata">

**Author:** ![aginghipster](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/e9c0ed/32.png) [@aginghipster](https://www.ruby-forum.com/u/aginghipster)\
**Post date:** [May 3, 2006, 5:25pm UTC](https://www.ruby-forum.com/t/rake-appdoc-question-regarding-comment-formatting/59273/3 "2006-05-03T17:25:10Z")

</div>

Thanks Steve, I tried many google searches but I think I must have been  
too specific as this page didn’t come up – its exactly what I need.

Thanks!  
Andy

Steve R. wrote:

> Google: ‘rdoc format’
> 
> Here’s a link that should help.
> 
> [File: README](http://rdoc.sourceforge.net/doc/files/README.html)
> 
> Andrew C. wrote:
> 
> > I tried googling and searching the forums here but was unable to locate  
> > an answer, please forgive if this has been covered.
> > 
> > Is there any way to provide formatting guidelines to dictate how parsed  
> > comments are displayed in the resulting html? In the simplest example,  
> > is there a way to specify a linebreak (break tag)?
> > 
> > Thanks,  
> > Andy