Re: [jarp-developer] JavaDoc Documentation
Brought to you by:
ricardo_padilha
From: Ricardo S. P. <pa...@lc...> - 2001-04-17 21:49:49
|
Hi, > Hmm, I read no indention at all in that example. Damn email clients... :) > I like that too, except for methods. I didn't quite catch you there... why should methods be different? > I can understand this, but unfortunately my editor does not support this; > everything inside a class is indented one level. Hmm... what should we do then? > tabs-size (I normally use 2). However, we should be aware that the code will > look awfully indented when viewed with a plain-vanilla editor using tabs of > size 8. I have previously emulated tabs with spaces, but there should be no > problem for me in using tabs instead. But the idea of using spaces to indent just "creeps" me. As you said, the great thing about using tabs is that you can set their size to whatever you want. > I've noticed that you don't have any empty lines between definitions. This > is probably ok if you have an IDE with class browser capabilities, but is > hard to navigate using a normal editor; even with JavaDoc comments, I find > that methods tend to blur into each other. I normally use 2 lines between > methods, but perhaps we could settle for a compromise of 1 line? Ok, one line it is (even two if you like). > There is also a question of rearranging methods and variables. I haven't > complete investigated how my editor does it, but it seems that is sort first > by access (private, protected, public) and then by scope (static, > non-static). It does not sort methods based on their name (so it possible to > keep related methods near each other). VAJ sorts by name. > I have attached an example of how my editor plug-in stylish a file. All > variable and methods was originally written in the order implied (A,B,... > and method1, method2,...). No JavaDoc blocks were originally there. The JavaDocs seems to be just like those generated by jDocHelper. > My plug-in have the following options on the general layout (with my default > in paranthesis): > > Put "else" and "catch" on new line or not (not). Same here. > Put "throws" clause on own line or keep with method signatur line (own > line). I was on with method signature. That's why you prefer to open braces for methods on new lines? > Put "{" and "}" on a line by themselves or not (not). Ok. > Put method brackes on a line by themselves or not (own line). Well, that's where we were different... > Put additional space in parenthesized expressions or not (not). Ok. > Put additional space after cats or not (space). What's this, exactly? > Put additional space after keywords or not (space). Ok. > Line up field definitions to a particular column or not (not). Ok. > Lines between field definitins (1). Well, this also I'll be changing. BR, Ricardo |