Styjun

Exactly which act of bravery are Luke and Han awarded a medal for?

Visual Studio Code download existing code

How do I minimise waste on a flight?

Is the tensor product (of vector spaces) commutative?

How to explain intravenous drug abuse to a 6-year-old?

How to avoid making self and former employee look bad when reporting on fixing former employee's work?

How could a civilization detect tachyons?

Opposite party turned away from voting when ballot is all opposing party

Was Mohammed the most popular first name for boys born in Berlin in 2018?

Colorless commander using lands that chose based upon identity?

Whose birthyears are canonically established in the MCU?

What happens when the drag force exceeds the weight of an object falling into earth?

Mindfulness of Watching Youtube

Is it a good idea to copy a trader when investing?

How would an instant or sorcery with an effect that targets work with Feather?

When was it publicly revealed that a KH-11 spy satellite took pictures of the first Shuttle flight?

Program for finding longest run of zeros from a list of 100 random integers which are either 0 or 1

The unknown and unexplained in science fiction

Why did Yoast put a no-index tag in my XML sitemap?

What will Doctor Strange protect now?

Is there an idiom that means "revealing a secret unintentionally"?

What's the difference between "ricochet" and "bounce"?

How to append code verbatim to .bashrc?

What are my options legally if NYC company is not paying salary?

C# documentation update after method signature change

How do I intercept a method call in C#?Pass Method as Parameter using C#Get only Methods with specific signature out of Type.GetMethods()Making a private method public to unit test it…good idea?How to call asynchronous method from synchronous method in C#?Writing method without declaring type of thatWhy not inherit from List<T>?EventSource - Unable to get method signature changes to applyObtaining method signatures types and namesHow to change starting point of a C# program to another method?

.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty height:90px;width:728px;box-sizing:border-box;

0

In C# I use /// for documenting methods. Is there any possible way how to update this documentation after method signature changes (without loosing information already entered)?

For example. I already have:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
public void SomeMethod(string userName)

I would like to update method documentation after method changes to:

public void SomeMethod(string userName, int age)

Edit: I'm looking for some automated solution for this task.

c# documentation

share|improve this question

edited Mar 23 at 7:21

Lenka Bendová

asked Mar 23 at 7:03

Lenka BendováLenka Bendová

33

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  You can manually edit the XML. In this case just add /// <param name="age">Age</param>
  
  – Henk Holterman
  Mar 23 at 7:11
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Beside from doing it manually you can use refactoring tools like Resharper. But it's not free. Maybe you find a free refactoring tool that also refactors XML comments. But renaming is supported by Visual Studio.
  
  – BionicCode
  Mar 23 at 7:14
  
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  If you are a student then Resharper is free.
  
  – BionicCode
  Mar 23 at 7:21
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Thank you guys. I'm going to do it with Resharper trial version. I've tried to find something free with no luck.
  
  – Lenka Bendová
  Mar 23 at 8:02
  

  
  
  
  

add a comment | 

0

In C# I use /// for documenting methods. Is there any possible way how to update this documentation after method signature changes (without loosing information already entered)?

For example. I already have:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
public void SomeMethod(string userName)

I would like to update method documentation after method changes to:

public void SomeMethod(string userName, int age)

Edit: I'm looking for some automated solution for this task.

c# documentation

share|improve this question

edited Mar 23 at 7:21

Lenka Bendová

asked Mar 23 at 7:03

Lenka BendováLenka Bendová

33

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  You can manually edit the XML. In this case just add /// <param name="age">Age</param>
  
  – Henk Holterman
  Mar 23 at 7:11
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Beside from doing it manually you can use refactoring tools like Resharper. But it's not free. Maybe you find a free refactoring tool that also refactors XML comments. But renaming is supported by Visual Studio.
  
  – BionicCode
  Mar 23 at 7:14
  
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  If you are a student then Resharper is free.
  
  – BionicCode
  Mar 23 at 7:21
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Thank you guys. I'm going to do it with Resharper trial version. I've tried to find something free with no luck.
  
  – Lenka Bendová
  Mar 23 at 8:02
  

  
  
  
  

add a comment | 

In C# I use /// for documenting methods. Is there any possible way how to update this documentation after method signature changes (without loosing information already entered)?

For example. I already have:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
public void SomeMethod(string userName)

I would like to update method documentation after method changes to:

public void SomeMethod(string userName, int age)

Edit: I'm looking for some automated solution for this task.

c# documentation

share|improve this question

edited Mar 23 at 7:21

Lenka Bendová

asked Mar 23 at 7:03

Lenka BendováLenka Bendová

33

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
public void SomeMethod(string userName)

public void SomeMethod(string userName, int age)

share|improve this question

edited Mar 23 at 7:21

Lenka Bendová

asked Mar 23 at 7:03

Lenka BendováLenka Bendová

33

share|improve this question

edited Mar 23 at 7:21

Lenka Bendová

asked Mar 23 at 7:03

Lenka BendováLenka Bendová

33

asked Mar 23 at 7:03

Lenka BendováLenka Bendová

33

asked Mar 23 at 7:03

Lenka BendováLenka Bendová

33

1 Answer
1

active

oldest

votes

1

Have a look at GhostDoc. It's on the visual studio marketplace too.

I've used the free version which will document methods for you (and update them). Just place the cursor on the method definition and press CTRL + SHIFT + D (by default) to update method/class documentation.

Below would be the result after updating your example:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
/// <param name="age">The age.</param>
public void SomeMethod(string userName, int age)

share|improve this answer

edited Mar 23 at 13:13

answered Mar 23 at 9:31

haldohaldo

2,7491823

add a comment | 

Your Answer

StackExchange.ifUsing("editor", function ()
StackExchange.using("externalEditor", function ()
StackExchange.using("snippets", function ()
StackExchange.snippets.init();
);
);
, "code-snippets");

StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "1"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);

else
createEditor();

);

function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);



);

draft saved

draft discarded

Sign up or log in

StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);

Sign up using Google

Sign up using Facebook

Sign up using Email and Password

Post as a guest

Name

Email

Required, but never shown

StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f55311438%2fc-sharp-documentation-update-after-method-signature-change%23new-answer', 'question_page');

);

Post as a guest

Name

Email

Required, but never shown

1

Have a look at GhostDoc. It's on the visual studio marketplace too.

I've used the free version which will document methods for you (and update them). Just place the cursor on the method definition and press CTRL + SHIFT + D (by default) to update method/class documentation.

Below would be the result after updating your example:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
/// <param name="age">The age.</param>
public void SomeMethod(string userName, int age)

share|improve this answer

edited Mar 23 at 13:13

answered Mar 23 at 9:31

haldohaldo

2,7491823

add a comment | 

1

Have a look at GhostDoc. It's on the visual studio marketplace too.

I've used the free version which will document methods for you (and update them). Just place the cursor on the method definition and press CTRL + SHIFT + D (by default) to update method/class documentation.

Below would be the result after updating your example:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
/// <param name="age">The age.</param>
public void SomeMethod(string userName, int age)

share|improve this answer

edited Mar 23 at 13:13

answered Mar 23 at 9:31

haldohaldo

2,7491823

add a comment | 

Have a look at GhostDoc. It's on the visual studio marketplace too.

I've used the free version which will document methods for you (and update them). Just place the cursor on the method definition and press CTRL + SHIFT + D (by default) to update method/class documentation.

Below would be the result after updating your example:

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
/// <param name="age">The age.</param>
public void SomeMethod(string userName, int age)

share|improve this answer

edited Mar 23 at 13:13

answered Mar 23 at 9:31

haldohaldo

2,7491823

/// <summary>
/// Example method for my question.
/// </summary>
/// <param name="userName">User name</param>
/// <param name="age">The age.</param>
public void SomeMethod(string userName, int age)

share|improve this answer

edited Mar 23 at 13:13

answered Mar 23 at 9:31

haldohaldo

2,7491823

answered Mar 23 at 9:31

haldohaldo

2,7491823

answered Mar 23 at 9:31

haldohaldo

2,7491823