SubMain.com
YouTube
RSS

GhostDoc

Home Category: GhostDoc

VS2022 Readiness Update

Serge Baranovsky8 Comments

If you are reading this post, you already know that Microsoft has announced a new version of Visual Studio 2022. And of course, we make sure that our products are available to help you improve your code and code documentation.

TLDR; We already have a version of GhostDoc Pro, GhostDoc Enterprise, and CodeIt.Right, that is compatible with Visual Studio 2022 Preview. If you are interested in trying these out, see the details at the end of this post.

Visual Studio is 64-bit

The most exciting news about Visual Studio 2022 is that it will be 64-bit. This is a giant leap forward as far as the memory available to the Visual Studio environment!

Due to the existing Visual Studio being a 32-bit process, it can only use a maximum of 4 GB of memory. That memory is shared between the project files, the runtime, the extensions, and the VS environment itself.

So regardless of how powerful your development rig is, current Visual Studio can only use some 4GB of memory, even if you got 32GB available.

VS2022 being x64 is excellent news! Especially if you have large solutions!

What does this mean for CodeIt.Right and GhostDoc?

Since both CodeIt.Right and GhostDoc are VS extensions and exist within that VS environment’s space, both will be taking advantage of the “breathing freedom” that a 64-bit environment provides.

Will CodeIt.Right and GhostDoc work with the new x64 Visual Studio?

Yes, they will. In fact, they already work with the VS2022 Preview 1!

Will Visual Studio x64 improve CodeIt.Right and GhostDoc performance?

It will! It is hard to tell at this point how great the improvement will be but just by the mere fact that on large solutions, our products won’t have to offload data to a drive cache and keep in memory – provides a massive improvement in performance!

When VS2022 compatible builds of CodeI.Right and GhostDoc will be available?

They are available as part of our INSIDERS testing program publicly right now! Use the button below.

Generally, with the new major VS releases, we have our products compatible with the first production-ready VS build. Typically this would be a VS pre-release build, sometimes a late beta. Microsoft does not recommend using the previews and betas for production use as these are intended for testing and evaluation.

But given the great interest in the x64 version of Visual Studio, as we already mentioned, we prioritized and currently have builds of GhostDoc Pro, GhostDoc Enterprise, and CodeIt.Right that are compatible with Visual Studio 2022 Preview 1. Please note: we do not have a GhostDoc Community edition build for VS2022 just yet.

While the version is compatible with VS2022, the VS itself is not quite ready for the extensions. One minor issue we are seeing is transparent tool windows in VS (no background). We have seen a very similar issue with VS19 Previews – the VS team has addressed that by the Beta version of VS19. Fixed now!

With the little caveat above, whenever you want to try the VS22 compatible GhostDoc Pro or Enterprise, just drop us a note at support at submain dot com, and we will hook you up with a nightly build download link.

Download GhostDoc Beta

Happy coding!

Released: GhostDoc v2021

Serge BaranovskyNo Comments

Note to the GhostDoc v2020 users: The v2021 requires a new license code. Users with License Protection or active Software Assurance subscription are eligible for a free upgrade. See the information at the bottom of this post for the details.

Now with TypeScript support

We added support for TypeScript language and TypeScript projects

Currently supported in
  • Document This
  • Re-document This
  • Document Type
  • Document File
  • Document Project
Not supported yet in
  • Document File Header
  • Document Checked Out Files
  • Exclude This from Documentation
  • Visual Comment Editor
  • Generate Help Documentation
  • Preview Comment
  • Documentation Maintenance

Dark Theme for help documentation

In addition to the FlatGray and FlatMain themes, GhostDoc is now offering the new DarkMain theme.

Other changes

  • Backup error-recovery compliant parsing engine that improves the quality of comment template generation in Document This/Type/File/Project, Comment Preview, and Build Help Documentation
  • Display subscription information in the About window
  • No longer distributing the legacy frame-based themes with GhostDoc – will be available for download at our support site

For the complete list of changes, see What’s New in GhostDoc v2021

How do I try it?

Download the v2021 at http://submain.com/download/ghostdoc/

Keep the feedback coming!

Let us know what you think of the new version here – http://submain.com/support/feedback/

Older version licenses

Note to the GhostDoc v2020 users: The 2020.x (or earlier) license codes won’t work with the v2021. For users with License Protection and active Software Assurance subscription, we have sent out the v2021 license codes. If you have not received or misplaced your new license, you can retrieve it on the My Account page. Users without the License Protection or with an expired Software Assurance subscription will need to purchase the new version – currently, we are not offering an upgrade path other than the Software Assurance subscription. For information about the upgrade, protection see our Software Assurance and Support – Renewal / Reinstatement Terms

Released: GhostDoc v2020

Serge BaranovskyNo Comments

If are you are a licensed user with a current subscription, you can retrieve your permanent v2020 license code using the MyAccount page.

The new major version of GhostDoc, v2020, is now available for download.

Changes in v2020

  • New and improved syntax editor for Rule Template editor and Visual Editor
  • New menu batch action – ‘Document Checked Out Files’
  • Documentation Maintenance – now allow analysis on Solution/Project level for ‘Missing Documentation’, ‘Auto-generated Documentation’, ‘Synchronize with member signature’
  • Documentation Maintenance – improved responsiveness and performance when running the maintenance analysis on a large number of files or projects.
  • New Re-Document action in the Visual Editor
  • Visual Editor improvements – <see> and <seealso> authoring support, key combination Ctrl+Enter now saves and close the window
  • Rule Template editor – easier template customization with improved Intellisense, added Quick Info (on mouseover), Completion List (Ctrl+Space), and Parameter Info
  • (EE) New x64 command-line utility allows producing help documentation for very large solutions
  • Now can document local functions

For the complete list of changes, see What’s New in GhostDoc v2020

Download GhostDoc

Feedback

We appreciate your feedback on the new features; please email us at support@submain.com or post in the GhostDoc Forum.

Older version licenses

Note to the GhostDoc v2019 users: The v2019.x (or earlier) license codes won’t work with the v2020. For users with License Protection and active Software Assurance subscription, we will be sending out the v2020 license codes. Alternatively, you can retrieve your v2020 licenses at the My Account page right now. Users without the License Protection or with expired Software Assurance subscription will need to purchase the new version. Currently, we are not offering an upgrade path other than the Software Assurance subscription. For information about the upgrade protection see our Software Assurance and Support – Renewal / Reinstatement Terms

C# Documentation: A Start to Finish Guide

Carlos Schults1 Comment

a treasure map signifying c sharp documentationIf you’re a regular reader of this blog, you’ll know that code documentation is a topic we tend to cover with a certain frequency. Another common topic is concepts related to the C# language. In today’s post, we make these two common subjects converge, by presenting a guide on C# documentation.

We’ll show you a step-by-step guide that will walk you through the necessary steps you need to take to create documentation for your C# code. You’ll start by adding documentation to your code using special XML comments and end by seeing how to generate rich documentation created from these comments. You’ll learn about the importance of code documentation, see how Visual Studio can turn the documentation you create into useful help messages, and get to know some tools that can help you in this work. Let’s get started!

(more…)

What to Look for in a C# Documentation Generator

Carlos SchultsNo Comments

Printer spitting out paper signifying c# documentation generator“Everything automatable will eventually be automated.” Have you heard that saying? I’d prefer to tweak it a little bit and say that everything automatable should be automated. If you’re a regular reader of the SubMain blog, you’ll know that we enthusiastically advocate for automation. In today’s post, we continue that trend, focusing on documentation generation. More specifically, we’ll walk you through some essential features you should consider when trying to pick a C# documentation generator. (more…)

Automated Documentation: What It Means and 3 Tools to Help

Carlos SchultsNo Comments

Automated documentationIf you’re a software developer, then I’d bet you use some kind of automated testing. And if you don’t, you certainly should. But what about “automated documentation?” Do you know what this means? Are you putting this technique to work for you? Most likely you’re not. And if that’s the case, you’ve come to the right place.

We’ll start out by exploring the role documentation plays in the modern software development world, which has, by and large, embraced agile methodologies. The post will show that yes, documentation is important and valuable even today.

Then we’ll proceed to cover automated documentation. We’ll start by examining the growing trend of using automation to improve the software development process itself, showing how automation has become a must for companies struggling to remain competitive. After that, we’ll define automated documentation and talk about the benefits it provides.

Finally, we’ll get to the tools, where we’ll briefly cover three tools that can help you and your team with your automated documentation strategy, sharing some final tips after that.

Let’s get started.

(more…)

Code Documentation: The Complete Beginner’s Guide

Eric BoersmaNo Comments

Readme_book_signifying_code_documentationYou’re a little ways into your first programming job, and things are getting easier. At first, all the code you had to deal with might have overwhelmed and confused you, but you’re starting to get the hang of it. That’s great! Now you’re wondering how to take the code you write to the next level. While there are lots of things to learn about your programming stack, many of which will make you a better programmer, there are a few that will serve you no matter what stack you work in. One of those is code documentation.

Many developers don’t write enough documentation, either because they don’t see the value or because they feel like they don’t have time. You don’t need to be one of those developers. With a little time and a lot of practice, you can add documentation for your code that makes reading it a joy to use for both you and anyone else who comes along.

(more…)

Released: GhostDoc v2019

Serge Baranovsky5 Comments

GhostDoc v2019 is now available!

You need this version if you want to use GhostDoc with Visual Studio 2019.

Download GhostDoc

Older version licenses

Note to the GhostDoc v2018 users: The v2018.x (or earlier) license codes won’t work with the v2019. For users with License Protection and active Software Assurance subscription, we will be sending out the v2019 license codes. Alternatively, you can retrieve your v2019 licenses at the My Account page right now. Users without the License Protection or with expired Software Assurance subscription will need to purchase the new version. Currently, we are not offering an upgrade path other than the Software Assurance subscription. For information about the upgrade protection see our Software Assurance and Support – Renewal / Reinstatement Terms

C# Comments: A Complete Guide, Including Examples

Carlos Schults4 Comments

C_sharp_comments_sign_with_arrowTime for another C#-related post. We’ve already covered a fair amount of the language’s keywords, types, and concepts in previous posts. Today’s post covers C# comments, a topic that you might think is trivial.

My mission in this post is to convince you otherwise. True, comments are far from being the most exciting programming topic you could think of, I admit. And sure, comments have gotten a negative reputation over the years. But there’s more to comments than you might think.

In this post, you’ll learn about the definition of C# comments, followed by common justifications for their usage. Then we’ll proceed to show you the different possible types of C# comments and how to use them in practice. Let’s get started.

(more…)

Software Documentation: What You Need to Document and How

Vlad GeorgescuNo Comments

 

A hand writing software documentation on paper

Software documentation is all about bringing clarity into a code baseline. It provides clues to clarify the meaning of certain code structures. For this purpose, we use best programming practices and tools to clarify our software.?When documenting software, we aim to minimize time spent hunting for meaning. We want anyone using or reading our code to know exactly what we meant when we wrote it. In addition, they should also know how to use our code without having to look for extra clues. Whether it’s an API, a suite of REST services, or simply a method in your code, it should all be clear.? When things are not clear, you have to dig up the meaning from other parts of the code, and this is a waste of time.

In this article, we’ll explore what information to document and how to do it. Lastly, we will talk about presenting our software documentation.

(more…)

Menu