Saturday 15 May 2010

asp.net - Automating ASP MVC.NET Web api documentation on the /Help page -



asp.net - Automating ASP MVC.NET Web api documentation on the /Help page -

i've been next instructions talk creating help pages web api, 1 illustration beingness http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages

i know descriptions rest paths, place these xml comments above respective methods.

/// <summary> /// looks info id. /// </summary> /// <param name="id">the id of data.</param>

but have many paths or many web api projects , want create process little faster. start if wanted simple 1 sentence descriptions automated. ok, simple description, maybe pulled name or convention of method name , mention of parameter types expect. simple stuff build off of.

i thinking automation project reside in same solution web api you're targeting, separate project. thanks.

if install ghostdoc can click on method , press ctrl + shift + d. add together basic xml doc elements, seek come simple description of method does, parameters , returned looking @ names, , figuring out convention-wise. descriptions not useful, can be. guess have adapt conventions little bit.

asp.net asp.net-mvc asp.net-web-api

No comments:

Post a Comment