| comment block style [message #156248] |
Wed, 28 April 2004 07:41  |
Eclipse User |
|
|
|
Originally posted by: wagner.stefan.berlin.de
This is a minor feature request- investigation.
Since we have syntax-highlightening in eclips, I don't see a good reason
for intensive asterixing a comment like this:
/**
* foobar will foobar on foo or bar
* @param baz
*/
void foobar (Baz baz)
but would prefer:
/**
foobar will foobar on foo or bar
@param baz
*/
void foobar (Baz baz)
Does someone agree?
Shall I generate a minor feature request?
|
|
|
| Re: comment block style [message #156303 is a reply to message #156248] |
Wed, 28 April 2004 11:34  |
| Eclipse User |
|
|
|
Originally posted by: bob.news.gmx.net
"Stefan Wagner" <wagner.stefan@berlin.de> schrieb im Newsbeitrag
news:c6n8r2$qkn$1@eclipse.org...
> This is a minor feature request- investigation.
>
> Since we have syntax-highlightening in eclips, I don't see a good reason
> for intensive asterixing a comment like this:
>
> /**
> * foobar will foobar on foo or bar
> * @param baz
> */
> void foobar (Baz baz)
>
> but would prefer:
>
> /**
> foobar will foobar on foo or bar
> @param baz
> */
> void foobar (Baz baz)
>
> Does someone agree?
> Shall I generate a minor feature request?
Hm, since not all people looking at these sources might have syntax
highlighting at hand I'd suggest to keep them asterix's in there. IMHO
it's not worth the effort to change that.
robert
|
|
|
| Re: comment block style [message #156311 is a reply to message #156303] |
Wed, 28 April 2004 17:23 |
| Eclipse User |
|
|
|
Originally posted by: wagner.stefan.berlin.de
Hi Robert,
> Hm, since not all people looking at these sources might have syntax
> highlighting at hand I'd suggest to keep them asterix's in there.
Since I don't produce source-code for others, this isn't very relevant
to me.
And even if - most people left notepad years ago. Shall we be
backward-compatible to the 1950?
My Dos-Editor (c++) in 1992 had coment-coloring.
I wouldn't like eclipse to do something to the code, which makes me
dependent on it, but this isn't a fact for this issue.
I guess you argue, because you're just used to this asterixing, ;) and
like it.
> IMHO not worth the effort
Could be an argument.
But I don't like it. It violates my deep aversion against redundancy. :)
|
|
|
| Re: comment block style [message #156333 is a reply to message #156311] |
Wed, 28 April 2004 14:51 |
 Dan Winterstein
Messages: 33
Registered: July 2009 |
Member |
|
|
I'm with you Stefan. But the asterixes are easily fixed:
Go to Window->Preferences->Java->Code Style->Code Templates
& edit all of the code & comment templates to not use asterixes.
Or (slightly quicker), you can edit the file:
workspace/.metadata/.plugins/org.eclipse.jdt.ui/codetemplate s.xml
Yours, etc.
- Dan
Stefan Wagner wrote:
> Hi Robert,
>
>> Hm, since not all people looking at these sources might have syntax
>> highlighting at hand I'd suggest to keep them asterix's in there.
>
>
> Since I don't produce source-code for others, this isn't very relevant
> to me.
> And even if - most people left notepad years ago. Shall we be
> backward-compatible to the 1950?
> My Dos-Editor (c++) in 1992 had coment-coloring.
>
> I wouldn't like eclipse to do something to the code, which makes me
> dependent on it, but this isn't a fact for this issue.
>
> I guess you argue, because you're just used to this asterixing, ;) and
> like it.
>
> > IMHO not worth the effort
>
> Could be an argument.
>
> But I don't like it. It violates my deep aversion against redundancy. :)
>
|
|
|
| Re: comment block style [message #156344 is a reply to message #156248] |
Wed, 28 April 2004 16:12 |
| Eclipse User |
|
|
|
Originally posted by: eclipse.rizzoweb.com
Stefan Wagner wrote:
> This is a minor feature request- investigation.
>
> Since we have syntax-highlightening in eclips, I don't see a good reason
> for intensive asterixing a comment like this:
>
> /**
> * foobar will foobar on foo or bar
> * @param baz
> */
> void foobar (Baz baz)
>
> but would prefer:
>
> /**
> foobar will foobar on foo or bar
> @param baz
> */
> void foobar (Baz baz)
>
> Does someone agree?
> Shall I generate a minor feature request?
>
That goes against standard practice in Java code. There are many code
conventions that have become standard practice - are we to start making
options to go against them all? Like another responder, I think it would
not be time/effort wisely spent by the dev team.
Also, it will only work with JavaDoc 1.4 and later.
Eric
--
You must first have a lot of patience to learn to have patience.
-Stanislaw Lec
|
|
|
| Re: comment block style [message #156356 is a reply to message #156333] |
Wed, 28 April 2004 20:29 |
| Eclipse User |
|
|
|
Originally posted by: wagner.stefan.berlin.de
Hi Daniel,
>
> I'm with you Stefan. But the asterixes are easily fixed:
>
> Go to Window->Preferences->Java->Code Style->Code Templates
> & edit all of the code & comment templates to not use asterixes.
>
> Or (slightly quicker), you can edit the file:
> workspace/.metadata/.plugins/org.eclipse.jdt.ui/codetemplate s.xml
Thanks - works well. (I should have found it myself!)
|
|
|
| Re: comment block style [message #156360 is a reply to message #156344] |
Wed, 28 April 2004 20:44 |
| Eclipse User |
|
|
|
Originally posted by: wagner.stefan.berlin.de
Hi eric,
> That goes against standard practice in Java code. There are many code
> conventions that have become standard practice - are we to start making
> options to go against them all?
There a good and bad standards.
This one isn't only a question of taste, but a question of tools and
traditions.
While the tools made big progress, coders kept their old c-fashion
traditions and inherited them to new coders.
The asterixes had sense on b/w displays - now they don't have good
reasons and stay only because of traditions.
If you don't rethink old traditions you get a slave of your traditions.
Some people used iNumber and sNumber for distinguishing int and String,
some used m_i_Number _i_Number to mark member - and classvariables which
is - urgl urgl - very ugly, and not very useful, if your ide may show
such facts in a more sophisticated way like eclipse (and every modern
IDE) does.
Some people use 'IFclickable', where the suffix 'able' already
indicates: an interface! 'Clickable' will do the job in team with a good
IDE.
If I'm missing an argument for asterixing, I would like to know -
perhaps I may learn something.
> Also, it will only work with JavaDoc 1.4 and later.
That's good for me.
Don't use Swing, because it needs 1.2!
|
|
|
| Re: comment block style [message #156510 is a reply to message #156360] |
Thu, 29 April 2004 04:08 |
| Eclipse User |
|
|
|
Originally posted by: eclipse.rizzoweb.com
Stefan Wagner wrote:
> Hi eric,
>
>> That goes against standard practice in Java code. There are many code
>> conventions that have become standard practice - are we to start
>> making options to go against them all?
>
>
> There a good and bad standards.
> This one isn't only a question of taste, but a question of tools and
> traditions.
What I consider important in this case is that there is nothing wrong
with the accepted standard. It does not have any drawbacks, and thus its
simple advantage of being universally accepted and understood is enough
to keep it around.
> Some people used iNumber and sNumber for distinguishing int and String,
> some used m_i_Number _i_Number to mark member - and classvariables which
> is - urgl urgl - very ugly, and not very useful, if your ide may show
> such facts in a more sophisticated way like eclipse (and every modern
> IDE) does.
This argument that brings up the silly, confusing notations some people
used for variable names in other languages is a straw man - it is not
really relevant IMO. Those kinds of notations are not widely accepted
standards - they are, in fact, rare in Java as compared to C/C++.
>> Also, it will only work with JavaDoc 1.4 and later.
>
>
> That's good for me.
> Don't use Swing, because it needs 1.2!
Another straw man - there are numerous systems in production and even
new development that have a JDK 1.3 (or earlier) requirement for various
reasons. JDK level (and Swing usage itself) is an architectural
decision; code comment format is not (should not be, at least).
Anyway, you are certainly free to make the feature request (and, more
importantly, able to contribute your own implementation) thanks to the
open-source nature of Eclipse; I just think it would be a waste of time
for the dev team given the huge number of already-open issues facing
them. But isn't it nice that we can disagree and yet still both be
satisfied with the product?
Eric
--
A man talking sense to himself is no more insane than a man talking
nonsense not to himself.
-Rosencrantz & Guildenstern
|
|
|
| Re: comment block style [message #156772 is a reply to message #156311] |
Fri, 30 April 2004 09:37 |
| Eclipse User |
|
|
|
Originally posted by: bob.news.gmx.net
"Stefan Wagner" <wagner.stefan@berlin.de> schrieb im Newsbeitrag
news:c6oauh$3rl$1@eclipse.org...
> Hi Robert,
> > Hm, since not all people looking at these sources might have syntax
> > highlighting at hand I'd suggest to keep them asterix's in there.
>
> Since I don't produce source-code for others, this isn't very relevant
> to me.
> And even if - most people left notepad years ago. Shall we be
> backward-compatible to the 1950?
> My Dos-Editor (c++) in 1992 had coment-coloring.
>
> I wouldn't like eclipse to do something to the code, which makes me
> dependent on it, but this isn't a fact for this issue.
>
> I guess you argue, because you're just used to this asterixing, ;) and
> like it.
No, I really don't care. At most you could say I'm used to it.
> > IMHO not worth the effort
>
> Could be an argument.
>
> But I don't like it. It violates my deep aversion against redundancy. :)
There are typically bigger redundancy problems in code. If this is your
most pressing redundancy problem, then y<ou get my congratulations: code
quality must be awful at your site. :-)
Cheers
robert
|
|
|
Powered by
FUDForum. Page generated in 0.03539 seconds
] 
Search
Help
Register
Login
Home
