SubMain.com
Google+
YouTube
RSS

GhostDoc

Home Category: GhostDoc (Page 2)
Too much commented out code in your codebase will have you pulling your hair out, like this poor guy.

Commented Out Code Is Junk In Your Codebase

Peter Morlion3 Comments

Why do we have the tendency to comment out code instead of just deleting it? The reason is that we don’t want to lose a piece of code that might come in handy in the future. Maybe we think we’re still going to need it because it solves some problem in an elegant way. Or maybe it’s because it helps us when debugging. It all boils down to fear of losing information. But commented out code will get in the way more than it will help you, and it’s better off being deleted. I’ll expand on why below and provide…

Released: GhostDoc v5.8 Update

Serge BaranovskyNo Comments

UPDATE: a fix for the VS slowdown when adding/renaming solution files included with the build 17335 on December 1, 2017 GhostDoc v5.8.17330 update is a maintenance update and includes Added SubMain.GhostDoc.Cmd.clr4.exe to run the command line utility on .NET FW 4.0 Now can add XML Comments for single files outside of the project Now don’t run new version check when in Debug mode Updated styling for <note> and <list> Improved scaling on high DPI monitors Issue documenting the Main method in the Community edition Issue with the conceptual content topic placement in the TOC Keep conceptual content tags in <solution>.GhostDoc.xml…

An entire large team arguing over the coding standard.

What’s Your Worst Experience with a Coding Standard?

Erik Dietrich9 Comments

I remember the first time I encountered GhostDoc.  It was an oasis in a professional desert of soul-sucking conformity. Okay, wait. Let me back up and explain. I was working in a custom app dev shop at the time.  While working there, I worked on an assortment of apps, big and small, and I delivered to an assortment of clients, big and small.  Some had their own internal maintenance devs, and some did not.  And yet, in spite of this disjoint, hodgepodge arrangement, the company maintained a single and relatively involved coding standard for dozens of folks on dozens of projects. The “Professional”…

Different tool vendors can help you automate API documentation.

How Do You Handle API Documentation?

Erik Dietrich1 Comment

The subject of API documentation reveals a fascinating property of the software development industry that makes it truly unique.  When you think of a product, you think of something polished and ready to ship.  That’s true of software and also of the broader world in general.  But only in software can you crack the product open to reveal its internals and then ship that as well, with a different purpose. When you expose an API, this is exactly what you do.  Take an offering like, say, the iconic Trello.  On the surface, you have a lightweight kanban utility with a…

A field guide to code comments

A Field Guide to Code Comments

Erik Dietrich9 Comments

For someone relatively new to the field of programming, the subject of code comments would cause some definite confusion.  That’s because experienced folks in the field can’t seem to agree on the topic.  Some call the practice a code smell and claim it’s to be avoided.  Yet others tell you to do it.  And still others strike the middle ground.  Confused yet?  I would be.  At the very least, I’d conclude that it’s a matter of personal taste. So today, I’d like to offer you something different.  Instead of offering yet another opinion to the mix (though I do have one), I’ll…

Released: GhostDoc v5.8

Serge BaranovskyNo Comments

GhostDoc v5.8 is a critical update for VS2017 users. Includes VS2017 performance and stability improvements, minor enhancements, and bug fixes. GhostDoc is no longer crashing VS2017 when working with .NET Core projects Issue when Document File action duplicates existing <seealso> tags for a class Issue of all solution project unchecked when opening the Build Help Documentation dialog first time For the complete list of changes, please see What’s New in GhostDoc v5 For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features Download the new build at http://submain.com/download/ghostdoc/

Released: GhostDoc v5.7

Serge BaranovskyNo Comments

A new GhostDoc update is available now – version 5.7. Includes VS2017 performance improvements, minor enhancements, and bug fixes.: Improved performance loading solutions in VS2017 by moving it to an async thread Resolved issue related to license activation with the VSIX install in VS2017 Fixed “Active content” security warning in the Comment Preview window Added progress indication for the Document File/Type batch actions with large number of the members to be documented Enabled .cshtml and .vbhtml file extensions for spell checking Improved performance of the Document File/Type batch actions Fixed issue related to the PathTooLongException when building help file For…

Captain Obvious will tell you that there are certain comments to avoid, such as documenting the obvious.

Not All Code Comments Help: What Should You Avoid?

Erik Dietrich2 Comments

The debate over whether or not to comment your code rages on, showing no signs of stopping.  Catalogers of anti-patterns include code comments as a code smell because they explain problems in your code instead of fixing them.  Not so, counter people on the other side of the aisle, sometimes angrily.  No doubt the conversation becomes only more civil and even-keeled from there. So-called religious wars like this emerge for a variety of reasons.  Human nature causes us to get attached to our own decisions and to assume people making different choices than us do so as a result of personality defects….

The Anatomy of a C# Spell Check

Anatomy of C# Spell Check

Erik DietrichNo Comments

With the vast ecosystem of tools and plugins around Visual Studio, the existence of a C# spell check shouldn’t come as a surprise.  But maybe it does.  It’s entirely possible that this sort of spell checking never occurred to you as something worth doing.  Or maybe it just never occurred to you at all. Personally, I think spell checking your code is most definitely worth doing.  I won’t belabor the point here, since I’ve made this case in the past.  Suffice it to say that since you can have it so effortlessly, you might as well get your spelling right….

GhostDoc v2018 Beta 2 is available

Serge BaranovskyNo Comments

In the Beta 2, build v2018.0.230, we are continuing to build out the Visual Editor features as well as improvements and fixes New menu – Open Comment Editor – (Ctrl-Shift-E) to open Visual Editing for XML Comments Visual Editor improvements New – Insert Image New – Add/Remove Hyperlink Added Visual Editing for source code samples in XML Comment New menu and VS command – Document File Header – allows to generate/update the file header without having to re-document the file Improved performance of the Document File/Type batch actions Other improvements and bug fixes For the complete list of changes, see…

Menu