You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mina.apache.org by Dave Roberts <da...@saaconsultants.com> on 2010/03/30 10:21:17 UTC
Re: svn commit: r928769
On 29/03/2010 22:35, Sai Pullabhotla wrote:
>
> Of course, a Source Code Formatter posted to the MINA web site would
> definitely be a plus as I do want to format and still keep the
> unchanged stuff as is.
http://mina.apache.org/developer-guide.data/ImprovedJavaConventions.xml
Or, go to the MINA home page, click on Developers Guide on the left,
then find the Coding Convention section....
"We follow Sun's standard Java coding convention except that we
always use spaces instead of tabs. Please download the Eclipse Java
formatter settings file before you make any changes to the code."
Re: svn commit: r928769
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 4/1/10 9:20 PM, Sai Pullabhotla wrote:
> Wouldn't you use HTML tags/pre-formatted text for those types of docs?
>
Yes, but I'm not sure that the formater respect the <pre> tags. To be
double checked ...
--
Regards,
Cordialement,
Emmanuel Lécharny
www.nextury.com
Re: svn commit: r928769
Posted by Sai Pullabhotla <sa...@jmethods.com>.
Wouldn't you use HTML tags/pre-formatted text for those types of docs?
Regards,
Sai Pullabhotla
On Thu, Apr 1, 2010 at 1:47 PM, Emmanuel Lecharny <el...@gmail.com> wrote:
> On 4/1/10 2:37 PM, Sai Pullabhotla wrote:
>>
>> I've imported this formatter, but this does not auto-format the Java
>> Docs. So, if I type a long line for a method comment, and format just
>> the method or the entire class, the comments/java docs are not
>> affected. Is it okay to enable the formatting on Javadocs and wrap the
>> lines at 80 just like the code?
>>
>
> That's not a good idea. We did that one at ADS, and all the painfully
> formatted comments where we exposed
> data structure were all broken as a consequence ...
>
> Just my 2 cts.
>
> --
> Regards,
> Cordialement,
> Emmanuel Lécharny
> www.nextury.com
>
>
>
Re: svn commit: r928769
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 4/1/10 2:37 PM, Sai Pullabhotla wrote:
> I've imported this formatter, but this does not auto-format the Java
> Docs. So, if I type a long line for a method comment, and format just
> the method or the entire class, the comments/java docs are not
> affected. Is it okay to enable the formatting on Javadocs and wrap the
> lines at 80 just like the code?
>
That's not a good idea. We did that one at ADS, and all the painfully
formatted comments where we exposed
data structure were all broken as a consequence ...
Just my 2 cts.
--
Regards,
Cordialement,
Emmanuel Lécharny
www.nextury.com
Re: svn commit: r928769
Posted by Sai Pullabhotla <sa...@jmethods.com>.
I've imported this formatter, but this does not auto-format the Java
Docs. So, if I type a long line for a method comment, and format just
the method or the entire class, the comments/java docs are not
affected. Is it okay to enable the formatting on Javadocs and wrap the
lines at 80 just like the code?
Regards,
Sai Pullabhotla
On Tue, Mar 30, 2010 at 3:21 AM, Dave Roberts
<da...@saaconsultants.com> wrote:
> On 29/03/2010 22:35, Sai Pullabhotla wrote:
>>
>> Of course, a Source Code Formatter posted to the MINA web site would
>> definitely be a plus as I do want to format and still keep the
>> unchanged stuff as is.
>
> http://mina.apache.org/developer-guide.data/ImprovedJavaConventions.xml
>
> Or, go to the MINA home page, click on Developers Guide on the left,
> then find the Coding Convention section....
>
> "We follow Sun's standard Java coding convention except that we
> always use spaces instead of tabs. Please download the Eclipse Java
> formatter settings file before you make any changes to the code."
>
Re: svn commit: r928769
Posted by Sai Pullabhotla <sa...@jmethods.com>.
Cool, thanks.
Regards,
Sai Pullabhotla
On Tue, Mar 30, 2010 at 3:21 AM, Dave Roberts
<da...@saaconsultants.com> wrote:
> On 29/03/2010 22:35, Sai Pullabhotla wrote:
>>
>> Of course, a Source Code Formatter posted to the MINA web site would
>> definitely be a plus as I do want to format and still keep the
>> unchanged stuff as is.
>
> http://mina.apache.org/developer-guide.data/ImprovedJavaConventions.xml
>
> Or, go to the MINA home page, click on Developers Guide on the left,
> then find the Coding Convention section....
>
> "We follow Sun's standard Java coding convention except that we
> always use spaces instead of tabs. Please download the Eclipse Java
> formatter settings file before you make any changes to the code."
>