I have just realized that when trying to add an auto generated Javadoc (by typing /** and then enter on top of a method) on methods that have the #Override annotation on them Eclipse only adds an empty Javadoc.
/**
*
*/
Whereas if the method doesnt have the #Override annotation Eclipse adds the default comment which I have specified through the settings (Window - Preferences - Java - Code Style - Code Templates - Comments - Types - Edit)
/**
* #author
*
* ${tags}
*
*/
I havent added any new plug ins, and I get the same output even if I restore to default the Pattern of the Javadoc.
There is a separate "Overriding methods" template for overridden methods. "Methods" is used for normal methods ("Types" is for classes).
All in Preferences > Java > Code Style > Code Templates', 'Comments' section.
Related
I have set the template for "Types" to be:
/** $$Id$$
* $$Author$$
* $$Revision$$
*
* ${cursor}
*/
However the ${cursor} isn't working as it ought to, you can see here ( http://help.eclipse.org/luna/index.jsp?topic=%2Forg.eclipse.jdt.doc.user%2Fconcepts%2Fconcept-template-variables.htm - top of the first table) how ${cursor} should work.
When I use this template (by typing /** and then pressing enter) I get the following (where | denotes the cursor position)
/**
* |$Id$
* $Author$
* $Revision$
*
*
*/
How can I fix this, or if I am at fault, how can I get the desired behaviour?
The help does not make it very clear but the variables list you reference only applies to the 'Java > Editor > Templates' templates and not to the 'Java > Code Style > Code Templates'.
There is a much more restricted list for variables for the Code Templates which does not include ${cursor}.
Only the variables shown by the 'Insert Variable...' button of the Edit Template dialog are available.
I am using Aptana Studio 3 (built on Eclipse) to edit my Zend Framework application. When I am editing a view script, I would like my IDE to provide code completion / auto-complete.
<?php echo $this->form...
Being that the view helper functions are not exactly classes that are instantiated, I don't get this sort of functionality out of the box. How can I go about adding this sort of functionality to Eclipse?
The only thing you can really do is use variable type hints, for example
<?php
/* #var $form Zend_Form */
$form = $this->form;
You will then get code completion for $form properties and methods.
View helpers can mostly be treated the same, eg
<?php
/* #var $headLinkHelper Zend_View_Helper_HeadLink */
$headLinkHelper = $this->getHelper('HeadLink');
Since you are using Aptana Studio, and not PDT, I'll add to the comment I posted above (as an answer).
The correct syntax in Aptana Studio is:
/**
* #var Foobar
*/
$obj; // You have to call the variable here (redundant call...)
$obj-> // will code assist the FooBar functions.
That redundant call is a deal breaker (IMHO), so I'm working on having additional support, like with the PDT special #var syntax suggested at #Phil's answer).
/* #var $obj Foobar */
$obj-> // will code assist the FooBar functions.
In any case, for backward compatibility, both will be supported in the Studio's next release.
Hope that helps
How can I add java docs to my java program using netbeans?
You have a number of options:
Right-click on a source package and select Tools > Analyse Javadoc. This will add Javadoc to all methods
Type /** on the line before a class, method or field declaration, and then press Enter. Default Javadoc will be created for that method
Place the cursor within a class or method declaration. Press Alt + Enter, and then select "Create Javadoc"
On the line above any method or class, type /** and hit enter.
Enter your comments in between.
Also, use the
#param
tag to specify parameters in a Javadoc:
/**
*
* A method
*
* #param abc Used to do nothing
*/
public static void doNothing(int abc) {
System.out.println(abc);
}
You can also use the Alt+Enter combination in Netbeans to automatically insert the Javadoc with all parameters, however remember that this method/field can't be private.
Is there a way to make Eclipse's built-in Java code formatter ignore comments? Whenever I run it, it turns this:
/*
* PSEUDOCODE
* Read in user's string/paragraph
*
* Three cases are possible
* Case 1: foobar
* do case 1 things
* Case 2: fred hacker
* do case 2 things
* Case 3: cowboyneal
* do case 3 things
*
* In all cases, do some other thing
*/
into this:
/*
* PSEUDOCODE Read in user's string/paragraph
*
* Three cases are possible Case 1: foobar do case 1 things Case 2: fred
* hacker do case 2 things Case 3: cowboyneal do case 3 things
*
* In all cases, do some other thing
*/
I have already played around with the Windows > Preferences > Java > Code Style > Formatter settings but can't find one for keeping comment formatting. I'm using Eclipse 3.4.0.
There is another solution that you can use to suppress the formatting of specific block comments. Use /*- (note the hyphen) at the beginning of the block comment, and the formatting
won't be affected if you format the rest of the file.
/*-
* Here is a block comment with some very special
* formatting that I want indent(1) to ignore.
*
* one
* two
* three
*/
Source: http://www.oracle.com/technetwork/java/javase/documentation/codeconventions-141999.html#350
Update 2010, as pointed by the OP and in this answer, the special string // #formatter:off in Eclipse 3.6 is enough.
It was not available at the time of the question.
Original answer: June 2009, Eclipse 3.4/3.5
With the Java Formatter (Windows > Preferences > Java > Code Style > Formatter), you can create a new Formatter profile.
In the Comments tab (in eclipse3.5), you can make sure, in the "Javadoc comment settings", to uncheck "Format HTML tags".
Check also the "Never join lines" in the "General settings" section.
Then your comment should be written as:
/**
* PSEUDOCODE
* Read in user's string/paragraph
*
* Three cases are possible:
* <dl>
* <dt>Case 1: foobar</dt>
* <dd> do case 1 things</dd>
* <dt>Case 2: fred hacker</dt>
* <dd> do case 2 things</dd>
* <dt>Case 3: cowboyneal</dt>
* <dd> do case 3 things</dd>
* </dl>
* In all cases, do some other thing
*/
Note: I have made a Javadoc comment, and not a simple comment, as I believe a comment with that much text in it may be better placed in front of a method. Plus, Javadoc sections have more formatting parameters to play with.
If it is in front of a method (true Javadoc), the HTML tags <dl>, <dt> and <dd> will help to present it properly within the Javadoc view.
I just learned from a co-worker that Eclipse offers special formatting tags that can be used for this:
// #formatter:off
/*
* ╔════════╦═══════╦══════════╗
* ║ Month ║ Sales ║ Position ║
* ╠════════╬═══════╬══════════╣
* ║ June ║ 44k ║ 2nd ║
* ║ July ║ 39k ║ 2nd ║
* ║ August ║ 49k ║ 4th ║
* ╚════════╩═══════╩══════════╝
*
* This comment shouldn't be formatted, and will now be ignored by the formatter.
*/
// #formatter:on
Note that you may need to manually enable this feature through the Preferences menu → Java > Code Style > Formatter, clicking on Edit, selecting the Off/On Tags tab and checking Enable Off/On tags (source).
A quick Google for the string #formatter:off brought me to this other SO answer, which mentioned this feature in the context of disabling the formatter for code blocks. I've confirmed that it works for line comments, "normal" block comments and Javadoc block comments as well.
Another possibility is to use HTML's <pre> in Javadoc:
/**
* <pre>
* this
* is
* kept
* as
* is
* </pre>
*/
At least this is how I tend to embed my ASCII-art in source code comments :)
Surround the specific text with <pre> </pre> tags.
In Eclipse 3.4: Preferences, Java->Code Style->Formatter, then edit profile, comments tab. There's a bunch of options there for controlling comment formatting.
one workaround is to add pre tag for the comments that you don't want eclipse to format
/**
* <pre>
* this part
* is
* out of
* format
*
* </pre>
*/
If you want to supress formatting in eclipse, you can always wrap content that is intended to NOT TO BE FORMATED into <pre>UNFORMATTED CONTENT</pre> tag. Javadoc formatter will detect that tag, and leave everything between that tags unformatted.
Pros:
Rest of Javadoc is still formatted
Javadoc's html output will be "unformatted" as well because of pre tags
Cons:
Not seeing one
Try this one. This worked for me.
With the Java Formatter (Windows > Preferences > Java > Code Style > Formatter), you can create a new Formatter profile from existing and then edit it.
If Eclipse doesn't allow to save this then create a new one and save in that.
It is language-dependent.
For example, if working with javascript, you would go to "Window -> Preferences -> Javascript -> Code Style -> Formatter" and then edit the formatter options.
Edit (reflecting changesin OP Questions
For editing java code formatting, go to
"Window -> Preferences -> Java -> Code Style -> Formatter"
At the top of the panel you will see
Active Profile:
Eclipse [built-in]
From there you have one button to the right, "Edit", and two below, "New..." and "Import...".
I would recommend Editing the existing profile.
In the edit profile dialog, there are a series of tabs along the top. The last tab is "Comments". To completely disable comment formatting, uncheck "Enable Javadoc comment formatting", "Enable block comment formatting", "Enable line comment formatting", and "Enable header comment formatting".
You can change this in
Windows - Preferences - Java - Code Style - Formatter,
than click the Edit.. button, find Comments,
choose the Never Join Lines.
Then, it should be OK.
i remember there being a way of marking a section of code in eclipse (special comment or annotation?) which made the autoformatter ignore that section. Or I may have drempt this...
Used mainly when I have strings which wrap onto several lines and i don't want the autoformatter to rearrange this.
Since eclipse 3.5 (or 3.6) this is possible:
- Go to project properties -- Java Code Style -- Formatter -- Edit...
- choose the tab marked "Off/On Tags",
- include the tags in comments in your source code, like
/* #formatter:on */
You can wrap the code you don't want auto-formatted between these special comments:
normal code
/* #formatter:off */
strangely laid out code
/* #formatter:on */
normal code
Here's a basic usage example that makes a json string (slightly) more readable:
public class SomeTest {
#Test
public void can_deserialize_json() {
/* #formatter:off */
String json = "" +
"{" +
" \"id\" : 123," +
" \"address1\" : blah," +
" \"shippingInfo\" : {" +
" \"trackingUrl\" : null," +
" \"price\" : 350" +
" }," +
" \"errorMessage\" : null" +
"}";
/* #formatter:on */
MyClass.deserializeJson(json);
}
}
I only know the answer for comments:
Eclipse is smart enough to only re-format the comments where the generated JavaDoc wouldn't change (i.e. where whitespace doesn't matter):
/**
* foo <i>
* bar </i>
*
* <pre>
* foo
* bar
* </pre>
*/
will be reformatted into
/**
* foo <i> bar </i>
*
* <pre>
* foo
* bar
* </pre>
*/
Note how the content of the <pre> tags is not reformatted.
For long String literals, I'd suggest that they might be an indication that you should be externalizing some of them.
I am not sure about the exact feature you're referring to, but you can change the line wrap policy of expressions, which may help you with your strings problem. See:
Window->Preferences->Java->Code Style->Formatter
Click "Edit..." Button
Click "Line Wrapping" Tab
In the tree, choose Expressions->Assignments, then change the indent policy at the bottom of the window.
Of course there are myriad other options inside the formatter, you may find many of those useful as well for other rules, such as where to put your braces, or how to indent control blocks.
I just found this question because I'm also annoyed by the lack of this feature.
A small search showed this question and the following answer:
Stop eclipse from line wrapping?
Eclipse 3.5 supports this. (It hit release candidate a a few days ago, so could be worth checking out)
Good luck with this! :)
I stumbled upon this, 'cause I'd love to see section coloring in Eclipse. Imagine you could simply give some background color to sections within your code. Wouldn't it make it more accessible, especially when you're faded at 4 a.m.? :)
You can mark the code you want to format and selct format with right mouse click in this section. This is a "whitlist" solution, perhaps it helps...