Isn't my suggestion StyleCop for ReSharper what you wanted? Note that words are recognized successfully only if you use the recommended Camel and Pascal casing appropriately which you ought to be doing anyway because you follow to the naming conventions. Among a lot of other stuff, it can automatically create comments when you clean your code. Introduction to GhostDoc Benefits Automatically generate a starting point for your help documentation Benefit of the base class documentation Visual Editor for XML Comments Produce help documentation in multiple formats Maintain clean and up-to-date code documentation Generate help documentation from your build Contemporary help documentation themes Intelligent source code Spell Checker StyleCop compliant documentation templates If you follow good naming conventions in your code, then you will get very decent results on the summary GhostDoc generates. How do we handle problem users?
Uploader: | Tutaxe |
Date Added: | 21 October 2010 |
File Size: | 50.2 Mb |
Operating Systems: | Windows NT/2000/XP/2003/2003/7/8/10 MacOS 10/X |
Downloads: | 1369 |
Price: | Free* [*Free Regsitration Required] |
Using GhostDoc is much faster than writing the documentation from scratch. You can generate documentation for classes, functions, etc. It might be what you are looking for, at least it is open source.
Alternatively, if you want source code for something very basic in this direction that will get you started, you could take a look here. Asked 8 years, 6 months ago.
Must have VS 2008 Free Plug-ins (2): Ghost-Doc
As the name seems to imply, Ghost-Doc plug-in for Visual Studio is something like that: Please note that some other commercial add-ins provide simple 'boilerplate'-based comment creation, and others provide ghistdoc documentation authoring and export processes.
Sign up for e-mail newsletters from DevX.
We keep this table up to date with recent releases updated every couple of monthsand have tried to be totally objective, so if you feel anything is missing or incorrect in this table, please let us know and we'll double-check our facts. Open Source Zone DevX: The function documentation will be added automatically, as shown below: Instead, describe the problem and what has been done so far to solve it. A few code-checking tools like StyleCop also expect developers to write the proper documentation during development.
Submit a Tip Browse ". In addition to standard features the free version Ghodtdoc offers, there is a GhostDoc Pro alternative which provides ultimate documentation configuration flexibility and automation of routine documentation operations.
After installing GhostDoc, open your Visual Studio. Produce help documentation in multiple formats See your comments as they appear in the help file.
Auto-generate Visual Studio Project Documentation with GhostDoc
Generated documentation comparison Quite a number of add-ins are available that build some form of documentation blocks automatically.
NET project and select the function name for which you want to generate the documentation ProcessLogin in this example.
Product Comparisons Below is a comparison of the Documentation Comment ghoxtdoc tools available for recent versions of Visual Studio. Clicking the link however would have solved the confusion: Note that words are recognized successfully only if you use the recommended Camel and Pascal casing appropriately which you ought to be doing anyway because you follow to the naming conventions.
Free Trial Buy Now. Stack Overflow for Teams is a private, secure va for you and your coworkers to find and share information.
Software Assurance subscription Annual subscription add-on provides minor and major upgrades during the cover period. The rest of this tip explains how to use GhostDoc to generate Visual Studio code documentation automatically.
Atomineer Pro Documentation for Visual Studio (,,,,,)
Commercial License For companies and organizations. Configurable rules, acronyms and macros. StyleCop can be used to generate comments?
The systems compared below are: Suppose you have a very simple class like the following: Version v adds contemporary frameless web help documentation themes.
c# - XML comments generator for VS - Stack Overflow
Isn't my suggestion StyleCop for ReSharper what you wanted? By using our site, you acknowledge that you have read and understand our Cookie PolicyPrivacy Policyand our Terms of Service.
Well, I ghpstdoc have been more specific. Automatically generate starting point for your help docs Generate XML comments based on code element type, parameters, name, and other contextual information.
Edwin de Koning Edwin de Koning
Комментариев нет:
Отправить комментарий