Quantcast
Channel: YouTrackReSharper (RSRP) - Bug and Issue Tracker
Viewing all articles
Browse latest Browse all 106942

RSRP-287835: CA to convert Javadoc to C# XML comment

$
0
0
Reporter Drew Noakes (drewnoakes) Drew Noakes (drewnoakes)
Created Jan 18, 2012 1:37:47 PM
Updated Jan 18, 2012 1:37:47 PM
Priority Normal
Type Feature
Fix versions No Fix versions
State Submitted
Assignee Unassigned
Subsystem Code Analysis
Affected versions 6.1
Fixed in build No Fixed in build
On several occasions I've ported some Java code to C# and spent quite a while manually adjusting the API documentation.

        /**
         * The number of elements in the queue. The length
         * indicates the number of elements that are currently
         * in the queue.
         *
         * @return the number of elements in the queue
         */


Becomes:

         /// <summary>
         /// The number of elements in the queue. The length
         /// indicates the number of elements that are currently
         /// in the queue.
         /// </summary>
         /// <returns>the number of elements in the queue</returns>


The most common Javadoc attributes are available in C# (@param, @return). Some Javadoc has HTML within it, which may be harder to convert (but not always impossible). I'd be happy to do those transformations myself, as even the simple conversion I show above takes a lot of work when done manually.

Viewing all articles
Browse latest Browse all 106942

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>