- About Scala
- In the Enterprise
- Scala Community
- Language Research
- In the Press
- The Scala Team
- Scala's Prehistory
- Contact Us
- Learning Scala
- Tour of Scala
- Scala API
- Setup & Getting Started
- Programming Guides
- Other Guides
- Code Examples
- Scala Developers
Re: scaladoc 2 convention on indenting scaladoc comments
Mon, 2011-05-09, 16:21
On Mon, May 9, 2011 at 5:16 PM, Rüdiger Keller
> 2011/5/9 Johannes Rudolph :
>> If I understand Simon's comment from the ticket, the problem is, that
>> the Scaladoc markup language (the 'wiki syntax') relies on indentation
>> to be correct. And this can be hard to get right if it isn't clear
>> what the left border of your text actually is.
> I don't see the problem here. Why should it be a problem to determine
> where the left border is? Unless you begin your comment in the first
> line starting with /** there are no ambiguities. And beginning in the
> first line would be against the conventions if I'm not mistaken.
> Sure, there is some rather involved regex code for handling the left
> border in the current Scaladoc implementation, but that isn't affected
> by the new style as far as I remember.
I think the intended benefit is for human-, rather than machine-, parseability.