Name: jl125535 Date: 08/21/2003 A DESCRIPTION OF THE REQUEST : I have something like: public class Something { int r; // This is the red component. int g; // This is the green component. int b; // This is the blue component. } The code works fine, but when I javadoc it the comments are ignored because they aren't between '/**' and '*/'. So I have two options: // The first option: /** This is the red component. */ int r; /** This is the green component. */ int g; /** This is the blue component. */ int b; // The second option: /** This is the red component. */ int r; /** This is the green component. */ int g; /** This is the blue component. */ int b; In the first case, the code becames very ugly and hard to read. In the second case it becames too big. Thinking about this, I suggest that you make javadoc work with a totally new formatted comments with '///'. So my code would look like this: int r; /// This is the red component. int g; /// This is the green component. int b; /// This is the blue component. Thanks. PS: I'm sorry of my very poor english, I am a brazilian... JUSTIFICATION : With those inline '///' comments, the code will be more legible, because the comments will be in the same line that is the code. It will be great and very simple! (Incident Review ID: 199385) ======================================================================
|