Skip to content

DOC208: Convert Javadoc to XML doc #51

Open
@drewnoakes

Description

@drewnoakes

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions