DotNetAnalyzers / DocumentationAnalyzers

Analyzers for XML documentation
MIT License
35 stars 6 forks source link

DOC208: Convert Javadoc to XML doc #51

Open drewnoakes opened 6 years ago

drewnoakes commented 6 years ago

This might be a bit far out for this project but I wanted to capture something that bugged me a while ago when converting Java to C# and performing very mechanical transformations on Javadoc comments.

/**
 * 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>

Even without perfect support for all Javadoc idioms, this could still save a lot of time, especially if applied solution-wide.

sharwell commented 6 years ago

This would not be too difficult if we leverage the work we'll have to put into #17, #3 (and related), and #15 (and related).