NetBeans Quick Tip #8 - Using Custom Folds

Guest Author

I have a friend who is a vim fanatic. You recognize his code by seeing many {{{ and }}} strings all over the sources. These strings are used to define custom folds in vim. They're just everywhere, it makes the code much less readable in other editors. Well, isn't this a typical example of user lock-in? ;-) If you're not using vim, sorry, your eyes have to skip all those {{{s.

Anyway, obviously folding seems to be an important issue for some of the people. Today's NetBeans tip is for all folding deviants. Did you know that next to usual NetBeans folds you can define custom folds? Maybe you've mentioned it in J2EE classes or in Swing forms, but in case you didn't here's a short explanation.

To add your custom fold, use following piece of text:

// <editor-fold>
Your code goes here...
// </editor-fold>

You can define default description of a collapsed fold like this:
// <editor-fold desc="This is my super secret genius code.">
Your code goes here...
// </editor-fold>

You can set a fold to be collapsed by default this way:
// <editor-fold defaultstate="collapsed">
Your code goes here...
// </editor-fold>

Happy folding!

Join the discussion

Comments ( 6 )
  • Gilhad Wednesday, July 6, 2005
    Hello from VIM fanatic ;-)

    but is not

    // {{{ <optional comment>

    your code ...

    // }}}

    simpler, smaller and cuter then some long XML tags? :-P

  • Roman Strobl Wednesday, July 6, 2005
    You're right, it's shorter in vim ;-) But can you define description and default state in vim? I would be surprise if you would not...
  • Nigel Leck Sunday, July 10, 2005
    There seems to be a small bug. If you use :-

    //<editor-fold desc="Start of auto generated elements" defaultstate="collapsed" >

    The "defaultstate" is shown in the comment but if you use:-

    //<editor-fold defaultstate="collapsed" desc="Start of auto generated elements">

    It works correctly.
  • Roman Strobl Monday, July 11, 2005
    Oh, yes, that's a bug. I've filed it.
  • Iwan Eising Thursday, September 1, 2005
    When will it be possible to just select a block of code and right-click on it, getting the option Create fold-block and have the XML-stuff generated by the IDE?
  • Roumen Saturday, September 3, 2005
    Iwan, thanks for all your suggestions. Why don't you file them into Issuezilla as enhancements? This way people can vote for them and somebody might create a patch for these features... you can of course try to develop it yourself, too :-) Thanks.
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.