Fixed bug with TODO comments on single word

Author: d1820

CodeDocumentor.Common/Extensions/ListExtensions.cs

@@ -163,7 +163,7 @@ public static List<string> HandleAsyncKeyword(this List<string> parts, bool excl
 
         public static List<string> TryAddTodoSummary(this List<string> parts, string returnType, bool useToDoCommentsOnSummaryError)
         {
-            if (returnType == "void" && (parts.Count == 1 || (parts.Count == 2 && parts.Last() == "asynchronously")))
+            if (IsReturnVoidAndOnePart(parts, returnType) || IsOnePart(parts))
             {
                 if (useToDoCommentsOnSummaryError)
                 {
@@ -177,6 +177,15 @@ public static List<string> TryAddTodoSummary(this List<string> parts, string ret
             return parts;
         }
 
+        private static bool IsReturnVoidAndOnePart(List<string> parts, string returnType) {
+            return returnType == "void" && (parts.Count == 1 || (parts.Count == 2 && parts.Last() == "asynchronously"));
+        }
+
+        private static bool IsOnePart(List<string> parts)
+        {
+            return (parts.Count <= 1 || (parts.Count == 2 && parts.Last() == "asynchronously"));
+        }
+
         public static List<string> TryPluarizeFirstWord(this List<string> parts)
         {
             if (parts.Count > 0)

CodeDocumentor.Common/Extensions/StringExtensions.cs

@@ -10,13 +10,13 @@ public static string RemovePeriod(this string text)
         }
 
         /// <summary>
-        ///  Withs the period.
+        ///  Add period if does not exist.
         /// </summary>
         /// <param name="text"> The text. </param>
         /// <returns> A string. </returns>
         public static string WithPeriod(this string text)
         {
-            if (text?.Trim().EndsWith(".") == true)
+            if (!string.IsNullOrWhiteSpace(text) && text.Trim().EndsWith("."))
             {
                 return text;
             }

CodeDocumentor.Common/Extensions/Translator.cs

@@ -13,6 +13,10 @@ public static class Translator
         /// <returns> A string </returns>
         public static string ApplyUserTranslations(this string text, WordMap[] wordMaps)
         {
+            if (string.IsNullOrWhiteSpace(text))
+            {
+                return text;
+            }
             return TranslateText(text, wordMaps);
         }
 

CodeDocumentor.Common/Models/Settings.cs

@@ -108,7 +108,7 @@ public ISettings Clone()
                 RecordDiagnosticSeverity = RecordDiagnosticSeverity,
                 TryToIncludeCrefsForReturnTypes = TryToIncludeCrefsForReturnTypes,
                 UseNaturalLanguageForReturnNode = UseNaturalLanguageForReturnNode,
-                UseToDoCommentsOnSummaryError = UseNaturalLanguageForReturnNode
+                UseToDoCommentsOnSummaryError = UseToDoCommentsOnSummaryError
             };
             var clonedMaps = new List<WordMap>();
             foreach (var item in WordMaps)

CodeDocumentor/Analyzers/BaseCodeFixProvider.cs

@@ -1,7 +1,6 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
-#if DEBUG
-#endif
+using System.Diagnostics;
 using System.Threading.Tasks;
 using CodeDocumentor.Common;
 using CodeDocumentor.Common.Interfaces;
@@ -65,8 +64,8 @@ public override FixAllProvider GetFixAllProvider()
         protected async Task RegisterFileCodeFixesAsync(CodeFixContext context, Diagnostic diagnostic)
         {
 #if DEBUG
-            //Debug.WriteLine("!!!DISABLING FILE CODE FIX. EITHER TESTS ARE RUNNING OR DEBUGGER IS ATTACHED!!!");
-            //return;
+            Debug.WriteLine("!!!DISABLING FILE CODE FIX. EITHER TESTS ARE RUNNING OR DEBUGGER IS ATTACHED!!!");
+            return;
 #endif
             //build it up, but check for counts if anything actually needs to be shown
             var tempDoc = context.Document;

CodeDocumentor/Helper/CommentHelper.cs

@@ -190,7 +190,8 @@ public string CreateMethodComment(string name, TypeSyntax returnType,
                          .TryInsertTheWord((parts) =>
                          {
                              //this means any name of a method that is not a return type of bool and not 2 part (+async) should insert "the" into the sentence
-                             if (!isBool &&
+                             if (parts.Count > 0 &&
+                                !isBool &&
                                 !hasReturnComment &&
                                 !Constants.EXCLUDE_THE_LIST_FOR_2PART_COMMENTS.Any(a => a.Equals(parts[0], StringComparison.InvariantCultureIgnoreCase)) &&
                                 is2partPlusAsync)

Manifests/vs2022/source.extension.vsixmanifest

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="CodeDocumentor.2022.88F29096-CA4C-4F88-A260-705D8BBFCF2A" Version="3.0.0.2" Language="en-US" Publisher="Dan Turco"/>
+        <Identity Id="CodeDocumentor.2022.88F29096-CA4C-4F88-A260-705D8BBFCF2A" Version="3.0.1.0" Language="en-US" Publisher="Dan Turco"/>
         <DisplayName>CodeDocumentor</DisplayName>
         <Description xml:space="preserve">An Extension to generate XML documentation automatically using IntelliSense for interface,class,enum, field, constructor, property and method.</Description>
         <Icon>logo.png</Icon>