Comment Your Code for point releases

Are you missing a feature? Request its implementation here.
dkb123
Posts: 11
Joined: Sat Jul 17, 2010 7:30 pm

Comment Your Code for point releases

Post by dkb123 »

Less a feature request and more a best practice.
With each new point release you make it would be great if you added a comment for new and changed code.
Something like
<!-- Oxygen 12.1 NEW -->
<!-- Oxygen 12.1 CHANGED -->

You comment patches and bug fixes, but not regular work. This is particularly an issue with the webhelp plugin, where I am currently running a Compare on the xsl files in the plugin folder to see what we need to do so that we can still use our customized webhelp and it will behave as expected, now that we have upgraded from 12 to 12.1.

Thanks :)
Radu
Posts: 9473
Joined: Fri Jul 09, 2004 5:18 pm

Re: Comment Your Code for point releases

Post by Radu »

Hi,

The WebHelp plugin was started from the DITA OT XHTML plugin.

We usually mark the patches we make to the DITA OT stylesheets (to help us upgrade from one DITA OT version to the other) but the WebHelp plugin is now a separate implementation and we no longer mark changes which we make to it.
Indeed when exposing Java API for example the new methods are marked and commented as such but when exposing full XSLT sources it's hard to do the same.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
Post Reply