About Site Map Submit Contact Us Log in | Create an account
Create an account Log In
Average Rating
User Rating:
Visitors Rating:
My rating:

Write review
  • License: Freeware
  • Last update: 5 years ago
  • Total downloads: 192
  • Price: Free |
  • Operating system: Win All
  • Publisher: atomineer.com
See full specifications

windows default iconAtomineerUtils Publisher's description

AtomineerUtils for Visual Studio provides unsurpassed code documentation (Documentation XML, Doxygen and JavaDoc format) comment generation, updating and conversions, as well as several handy outlining, code generation and clipboard commands.

AtomineerUtils for Visual Studio provides unsurpassed code documentation (Documentation XML, Doxygen and JavaDoc format) comment generation, updating and conversions, as well as several handy outlining, code generation and clipboard commands.

AtomineerUtils supports C#, Visual Basic, C++/CLI, C++, C and Java code

* Save time - save effort - save money.
* Eliminate almost all the drudgery of filling in documentation.
* Effortlessly keep code and documentation in sync.
* Encourage better coding, naming and documentation practices.
* Speed up development and reduce errors with intellisense help on all your own classes and methods.
* Easily satisfy Code Analysis and Static Analysis requirements for documentaion.
* Convert and update legacy documentation into a new standard.

Features - Document code better faster tidier cheaper

With a single keypress or menu command, the add-in can:

* Create or update highly configurable Documentation XML, Doxygen or JavaDoc-format documentation comments for code elements (file, namespace, class, interface, struct, enum, variable, property, event, delegate and function) in your code. This includes advanced support for automatically documenting all parameters, generic type parameters, thrown exceptions and return codes, automatically making use of existing documentation from related base class and override methods/properties and existing parameters within the same class, generating accurate and specialised documentation for hundreds of common function, class and parameter types. Comments can be converted between the supported formats to update legacy documentation to a new standard. It can also optionally reformat the updated text using automated indentation and word wrapping to keep your code documentation accurate, informative and tidy with a minimum of effort on your part. An absolutely essential tool for any team wishing to write maintainable code.
* Automatically document/convert every code element within a namespace/interface/class/struct/enum scope.
* Word-wrap the text in a block comment.
* Hide all documentation comments and/or attribute declarations using Visual Studio's Outlining facility.
* Auto-generate a C++/C skeleton implementation (in your source file) from a declaration (in a header).
* Open the matching header for a given C++ source file, or the matching source file for a given header.
* Add a C++/C declaration to your header for any existing method implementation.
* Create C# Auto-Properties, Explicit Properties or C++ Accessor functions from member variable declarations.
* Copy code to the clipboard in a clean format ideal for use in applications such as when writing Word .doc Documentation, or emailing examples to team members.

Documentation - what's so special about that?

For teams of developers to work on a product, they need to efficiently transfer information about their classes and methods to each other. Even a lone programmer will forget the finer details of code he wrote weeks ago. When you're writing code that calls a method, you don't want to waste time jumping to the code for that method to read it and work out what it does and how to call it. Documentation comments allow you to see that information as an intellisense tool-tip display as you type - the purpose of a method and details of the parameters and return value. This significantly improves productivity and reduces errors.

In addition, tools like Doxygen (all languages) and SandCastle or NDoc (.NET languages) can be used to generate professional external documentation like that used in MSDN - essential for libraries and other code that will be shipped to third parties, as well as being very useful for internal use by your team.

There are just three problems:

* Writing documentation is very time consuming
* Programmers usually prefer to write code than documentation - so the documentation suffers
* Even dedicated documentors will find their comments often get 'out of sync' with the code

AtomineerUtils auto-generated documentation confers a number of benefits:

* It provides the raw block skeleton instantly, in a standardised (but user-configurable) format
* It minimises the effort involved in documenting. A high proportion of documentation content is repetitive and easily filled in by the computer rather than the developer. Although you often have to tweak and augment the comments AtomineerUtils provides, it's usually impressively close to what you need, thanks to AtomineerUtils' advanced heuristic approach. This saves a lot of developer time and encourages developers to document their code well, because it is almost effortless.
* AtomineerUtils automatically keeps the documentation accurate when parameters, return values and thrown exceptions are changed in a method, or get/set accessors are added to a property. This is the only realistic way of keeping documentation 100% in sync with the code.
* Doc comments are picked up instantaneously by Visual Studio to give you the information in intellisense tool-tips as you type method-calls. ('Self-documenting code' is great, but you have to visit the code and read it to work out what it does - very inefficient compared to just reading the documentaiton as you type the call).
* It keeps documentation and surrounding code tidy by enforcing line breaks, formatting, element ordering, indentation, auto punctuation and word wrapping. All these options are highly configurable so it's easy to generate comments in the style you prefer.
* It encourages higher quality code - Good descriptive names usually auto-generate most of the documentation comment for you, while poor names leave you with more work to complete the documentation, so AtomineerUtils actively encourages a better coding style.
* It encourages developers to write documentation and keep it up to date. Programmers want to write code, not docs, so minimising the time and effort involved in documenting raises morale and improves the quality of documentation.

Put simply, AtomineerUtils raises developer morale, increases code quality, and typically saves thousands of dollars per developer per year.

What's New in This Release:

В· Improved 'Document all in this Scope' to handle C/C++ better - The most significant improvement is that header files are now supported and class declarations can be documented.
В· When adding a file header, any existing file header comment is now replaced by the new header comment, making it much easier to update file headers to a new style. (Note that file headers are still treated as plain text (i.e. not parsed and reformatted) - they are simply replaced)
В· Improved formatting of [in], [out] and [in,out] param entries.
В· Fixed a sneaky bug (it only occurred in the formatting of Javadoc comments in Auto-brief mode with long top separators), where a portion of the separator text could be repeated in the start of the brief description.

System Requirements:

No special requirements.
Program Release Status: Major Update
Program Install Support: Install and Uninstall

AtomineerUtils Tags:

Click on a tag to find related softwares

Is AtomineerUtils your software?

Manage your software

Most Popular

windows default icon WinAVR 20100110
WinAVR is a suite of executable, open source software development tools for the Atmel AVR series of RISC... Read more
windows default icon SQL-Front
SQL-Front MySQL GUI for database changes, data editing, SQL queries and more
windows default icon xVideo 1.2.1
xVideo is a Directshow wrapper that will help it’s users create multimedia applicationsIt’s
windows default icon Red Gate's .NET Reflector
Explore, browse, and analyze .NET assemblies

Related Category

» Active X (462)
» C & C++ & C# (244)
» Debugging (132)
» Delphi (191)
» Help Tools (211)
» Install & Setup (161)
» Other (1286)
» Source Editors (201)