search

atulmore777 / gwt-html-editor

Automatically exported from code.google.com/p/gwt-html-editor
0 stars 0 forks source link

Time to apply code conventions? #18

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
Hi, all,

Looks like the project has drawn attention and has a potential for growth.
Considering this maybe it would be a good thing to enforce code style while
the code base is small. I am pretty impressed by the tidiness of the code
already. The things I've noticed is that right now indentation is done via
tabs and there's no JavaDocs. Maybe we should take a look at GWT Code Style
recommendations
(http://code.google.com/webtoolkit/makinggwtbetter.html#codestyle) or Sun's
Java(TM) Language Code Conventions
(http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html) and mention
it somewhere in the Wiki.

Although I have always used Sun's version, I must confess that GWT Code
Style might be a better choice for two reasons:
1. I like the fact that in GWT indentation is only 2 and 4 characters,
compared to 4 and 8.
2. This project is all about GWT.

The only reason I set priority to 'Critical' is because applying code style
in the early stage is easier because not many people are contributing code
and avoids conflicts.

Thanks,

Yegor

Original issue reported on code.google.com by Yegor.Jb...@gmail.com on 10 Jan 2007 at 10:13

GoogleCodeExporter commented 9 years ago 
Second.
Related issue:
  http://code.google.com/p/gwt-html-editor/issues/detail?id=15

Original comment by pave...@gmail.com on 10 Jan 2007 at 10:21

GoogleCodeExporter commented 9 years ago

Original comment by pave...@gmail.com on 10 Jan 2007 at 10:25

GoogleCodeExporter commented 9 years ago 
Should I do it? I can do it right away.

Original comment by Yegor.Jb...@gmail.com on 10 Jan 2007 at 10:31

GoogleCodeExporter commented 9 years ago 
Go ahead.

Original comment by pave...@gmail.com on 10 Jan 2007 at 10:38

GoogleCodeExporter commented 9 years ago 
I have committed the new code style. Please, do svn update before making 
changes to
the code, because it will conflict with almost anything. I have also attached 
the
code formatter for Eclipse 3.2 that I used to format the code. Just go to 
Window ->
Preferences -> Java -> Code Style -> Formatter -> Import... and point it to the 
file.
If everyone likes it, maybe we can add this file to SVN for everyone to use.

Original comment by Yegor.Jb...@gmail.com on 10 Jan 2007 at 11:35

Attachments: