[2170] Javascript parameter renaming issue

Our coding standards mandate that all functions include XML documentation
for all parameters as well as the standard summary tags.  While the R#
renaming of parameters work well (thanks! ;) ), it does not find the param
tags in the XML documentation.

As an (very simple) example, consider the following code:

var myFunction = function(paraa1, param2, param3) {
    ///  tag will not.

1 comment

Hello David,

Thank you for feedback! I've created a report in our tracker: http://youtrack.jetbrains.net/issue/RSRP-273195
and you're welcome to monitor its status.

Andrey Serebryansky
Senior Support Engineer
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"

Our coding standards mandate that all functions include XML
documentation for all parameters as well as the standard summary tags.
While the R# renaming of parameters work well (thanks! ;) ), it does
not find the param tags in the XML documentation.

As an (very simple) example, consider the following code:

var myFunction = function(paraa1, param2, param3) {
/// <summary>
///    This is an example function.
/// </summary>
/// <param name="paraa1" type="String">The first
parameter.</param>
/// <param name="param2" type="String">The second
parameter.</param>
/// <param name="param3" type="String">Yet another
parameter.</param>
alert("Input parameters: '" + paraa1 + "', '" + param2 + "', '" +
param3
+ "'");
}
If I place the cursor on the paraa1 parameter in the function
definition and press Ctrl-R, R I can then rename it to param1 with no
issues.  The instance of the parameter in the alert will update as
expected, but the name attribute in the first <param> tag will not.



0

Please sign in to leave a comment.