Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Replace property with method" throws away XML comments #18234

Closed
davkean opened this issue Mar 28, 2017 · 2 comments
Closed

"Replace property with method" throws away XML comments #18234

davkean opened this issue Mar 28, 2017 · 2 comments
Assignees
Milestone

Comments

@davkean
Copy link
Member

davkean commented Mar 28, 2017

    internal interface ILanguageServiceHost
    {
        /// <summary>
        ///     Gets the active workspace project context that provides access to the language service for the active configured project.
        /// </summary>
        /// <value>
        ///     An <see cref="object"/> that provides access to the language service for the active configured project.
        /// </value>
        object ActiveProjectContext
        {
            get;
        }
    }
  1. Use Convert to method code action

Expected:

    internal interface ILanguageServiceHost
    {
        /// <summary>
        ///     Gets the active workspace project context that provides access to the language service for the active configured project.
        /// </summary>
        /// <returns> <-- Note <returns /> not <value />
        ///     An <see cref="object"/> that provides access to the language service for the active configured project.
        /// </returns>
        object GetActiveProjectContext();
    }

Actual:

    internal interface ILanguageServiceHost
    {
        object GetActiveProjectContext();
    }
@davkean
Copy link
Member Author

davkean commented Mar 28, 2017

tag @CyrusNajmabadi

@sharwell
Copy link
Member

💡 For whoever ends up working on this, make sure to handle the case where a property contains a <returns> element in the documentation. If there is a <returns> but no <value> element, the translation is just a copy, but if there are both a <returns> and <value> element we'll have to figure out a way to handle it that doesn't just make the content disappear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants