Skip to content

Commit 89d84d4

Browse files
d1820d1820
authored
added inline exception support
* added inline exception support
1 parent 8ec2650 commit 89d84d4

12 files changed

Lines changed: 162 additions & 19 deletions

‎CodeDocumentor.Test/CodeDocumentor.Test.csproj‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@
3131
<Compile Remove="Methods\TestFiles\MethodWithBooleanParameterTestFixCode.cs" />
3232
<Compile Remove="Methods\TestFiles\MethodWithCrefTestCode.cs" />
3333
<Compile Remove="Methods\TestFiles\MethodWithCrefTestFixCode.cs" />
34+
<Compile Remove="Methods\TestFiles\MethodWithExceptionTestCode.cs" />
35+
<Compile Remove="Methods\TestFiles\MethodWithExceptionTestFixCode.cs" />
36+
<Compile Remove="Methods\TestFiles\MethodWithInlineExceptionTestCode.cs" />
37+
<Compile Remove="Methods\TestFiles\MethodWithInlineExceptionTestFixCode.cs" />
3438
<Compile Remove="Methods\TestFiles\MethodWithIntReturnTestCode.cs" />
3539
<Compile Remove="Methods\TestFiles\MethodWithIntReturnTestFixCode.cs" />
3640
<Compile Remove="Methods\TestFiles\MethodWithListIntReturnTestCode.cs" />
@@ -39,6 +43,8 @@
3943
<Compile Remove="Methods\TestFiles\MethodWithListListIntReturnTestFixCode.cs" />
4044
<Compile Remove="Methods\TestFiles\MethodWithListQualifiedNameReturnTestCode.cs" />
4145
<Compile Remove="Methods\TestFiles\MethodWithListQualifiedNameReturnTestFixCode.cs" />
46+
<Compile Remove="Methods\TestFiles\MethodWithMixedExceptionTestCode.cs" />
47+
<Compile Remove="Methods\TestFiles\MethodWithMIxedExceptionTestFixCode.cs" />
4248
<Compile Remove="Methods\TestFiles\MethodWithNullableStructParameterTestCode.cs" />
4349
<Compile Remove="Methods\TestFiles\MethodWithNullableStructParameterTestFixCode.cs" />
4450
<Compile Remove="Methods\TestFiles\MethodWithObjectReturnTestCode.cs" />
@@ -67,6 +73,24 @@
6773
<Content Include="Methods\TestFiles\InheritDocTestCode.cs">
6874
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
6975
</Content>
76+
<Content Include="Methods\TestFiles\MethodWithMixedExceptionTestCode.cs">
77+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
78+
</Content>
79+
<Content Include="Methods\TestFiles\MethodWithInlineExceptionTestCode.cs">
80+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
81+
</Content>
82+
<Content Include="Methods\TestFiles\MethodWithExceptionTestCode.cs">
83+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
84+
</Content>
85+
<Content Include="Methods\TestFiles\MethodWithMixedExceptionTestFixCode.cs">
86+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
87+
</Content>
88+
<Content Include="Methods\TestFiles\MethodWithInlineExceptionTestFixCode.cs">
89+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
90+
</Content>
91+
<Content Include="Methods\TestFiles\MethodWithExceptionTestFixCode.cs">
92+
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
93+
</Content>
7094
</ItemGroup>
7195

7296
<ItemGroup>

‎CodeDocumentor.Test/Methods/MethodUnitTests.cs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System.Diagnostics.CodeAnalysis;
1+
using System.Diagnostics.CodeAnalysis;
22
using System.Threading.Tasks;
33
using CodeDocumentor.Test.TestHelpers;
44
using Microsoft.CodeAnalysis;
@@ -73,6 +73,9 @@ public async Task NoDiagnosticsShow(string testCode)
7373
[InlineData("MethodWithListListIntReturnTestCode", "MethodWithListListIntReturnTestFixCode", 9, 32)]
7474
[InlineData("MethodWithListQualifiedNameReturnTestCode", "MethodWithListQualifiedNameReturnTestFixCode", 9, 26)]
7575
[InlineData("MethodWithCrefTestCode", "MethodWithCrefTestFixCode", 10, 35)]
76+
[InlineData("MethodWithExceptionTestCode", "MethodWithExceptionTestFixCode", 9, 23)]
77+
[InlineData("MethodWithInlineExceptionTestCode", "MethodWithInlineExceptionTestFixCode", 9, 23)]
78+
[InlineData("MethodWithMixedExceptionTestCode", "MethodWithMixedExceptionTestFixCode", 9, 23)]
7679
public async Task ShowMethodDiagnosticAndFix(string testCode, string fixCode, int line, int column)
7780
{
7881
var fix = _fixture.LoadTestFile($"./Methods/TestFiles/{fixCode}.cs");

‎CodeDocumentor.Test/Methods/TestFiles/MethodWithExceptionTestCode.cs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text;
4+
5+
namespace ConsoleApp4
6+
{
7+
public class MethodTester
8+
{
9+
public string ShowMethodWithStringReturnTester()
10+
{
11+
throw new ArgumentNullException("test");
12+
}
13+
}
14+
}

‎CodeDocumentor.Test/Methods/TestFiles/MethodWithExceptionTestFixCode.cs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text;
4+
5+
namespace ConsoleApp4
6+
{
7+
public class MethodTester
8+
{
9+
/// <summary>
10+
/// Show method with string return tester.
11+
/// </summary>
12+
/// <exception cref="ArgumentNullException"></exception>
13+
/// <returns>string</returns>
14+
public string ShowMethodWithStringReturnTester()
15+
{
16+
throw new ArgumentNullException("test");
17+
}
18+
}
19+
}

‎CodeDocumentor.Test/Methods/TestFiles/MethodWithInlineExceptionTestCode.cs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text;
4+
5+
namespace ConsoleApp4
6+
{
7+
public class MethodTester
8+
{
9+
public string ShowMethodWithStringReturnTester()
10+
{
11+
ArgumentNullException.ThrowIfNull("test", "test");
12+
}
13+
}
14+
}

‎CodeDocumentor.Test/Methods/TestFiles/MethodWithInlineExceptionTestFixCode.cs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text;
4+
5+
namespace ConsoleApp4
6+
{
7+
public class MethodTester
8+
{
9+
/// <summary>
10+
/// Show method with string return tester.
11+
/// </summary>
12+
/// <exception cref="ArgumentNullException"></exception>
13+
/// <returns>string</returns>
14+
public string ShowMethodWithStringReturnTester()
15+
{
16+
ArgumentNullException.ThrowIfNull("test", "test");
17+
}
18+
}
19+
}

‎CodeDocumentor.Test/Methods/TestFiles/MethodWithMixedExceptionTestCode.cs‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text;
4+
5+
namespace ConsoleApp4
6+
{
7+
public class MethodTester
8+
{
9+
public string ShowMethodWithStringReturnTester()
10+
{
11+
ArgumentNullException.ThrowIfNull("test", "test");
12+
ArgumentException.ThrowIfNullOrEmpty("test", "test");
13+
}
14+
}
15+
}

‎CodeDocumentor.Test/Methods/TestFiles/MethodWithMixedExceptionTestFixCode.cs‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Text;
4+
5+
namespace ConsoleApp4
6+
{
7+
public class MethodTester
8+
{
9+
/// <summary>
10+
/// Show method with string return tester.
11+
/// </summary>
12+
/// <exception cref="ArgumentNullException"></exception>
13+
/// <exception cref="ArgumentException"></exception>
14+
/// <returns>string</returns>
15+
public string ShowMethodWithStringReturnTester()
16+
{
17+
ArgumentNullException.ThrowIfNull("test", "test");
18+
ArgumentException.ThrowIfNullOrEmpty("test", "test");
19+
}
20+
}
21+
}

‎CodeDocumentor/Helper/DocumentationHeaderHelper.cs‎

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,10 @@
22
using System.Collections.Generic;
33
using System.Linq;
44
using System.Text.RegularExpressions;
5-
using System.Threading;
65
using CodeDocumentor.Vsix2022;
7-
using EnvDTE;
86
using Microsoft.CodeAnalysis;
97
using Microsoft.CodeAnalysis.CSharp;
108
using Microsoft.CodeAnalysis.CSharp.Syntax;
11-
using Microsoft.VisualStudio.OLE.Interop;
12-
using SimpleInjector.Diagnostics;
139

1410
namespace CodeDocumentor.Helper
1511
{
@@ -34,6 +30,14 @@ public static class DocumentationHeaderHelper
3430
/// <summary> The summary. </summary>
3531
public const string SUMMARY = "summary";
3632

33+
/// <summary> The reg ex. </summary>
34+
private static readonly Regex _regEx = new Regex(@"throw\s+new\s+\w+", RegexOptions.IgnoreCase | RegexOptions.Multiline);
35+
36+
private static readonly Regex _regExInline = new Regex(@"(\w+Exception)\.Throw\w+", RegexOptions.IgnoreCase | RegexOptions.Multiline);
37+
38+
/// <summary> type param regex. </summary>
39+
private static readonly Regex _typeParamRegex = new Regex(@"""\w+""");
40+
3741
/// <summary> Creates the exception nodes. </summary>
3842
/// <param name="exceptionType"> The exception type. </param>
3943
/// <returns> An array of XmlNodeSyntaxes </returns>
@@ -559,14 +563,23 @@ internal static SyntaxTriviaList UpsertLeadingTrivia(this SyntaxTriviaList leadi
559563
/// <returns> <![CDATA[IEnumerable<string>]]> </returns>
560564
internal static IEnumerable<string> GetExceptions(string textToSearch)
561565
{
566+
562567
if (string.IsNullOrEmpty(textToSearch))
563568
{
564569
return Enumerable.Empty<string>();
565570
}
571+
572+
573+
566574
var exceptions = _regEx.Matches(textToSearch).OfType<Match>()
567575
.Select(m => m?.Groups[0]?.Value)
568-
.Distinct();
569-
return exceptions;
576+
.ToList();
577+
System.Diagnostics.Debugger.Break();
578+
579+
var exceptionsInline = _regExInline.Matches(textToSearch).OfType<Match>()
580+
.Select(m => m?.Groups.Count == 1 ? m?.Groups[0]?.Value : m?.Groups[1]?.Value).ToArray();
581+
exceptions.AddRange(exceptionsInline);
582+
return exceptions.Distinct();
570583
}
571584

572585
/// <summary> Withs the exception types. </summary>
@@ -722,12 +735,6 @@ internal static SyntaxList<XmlNodeSyntax> WithTypeParamters(this SyntaxList<XmlN
722735

723736
#endregion Builders
724737

725-
/// <summary> The reg ex. </summary>
726-
private static readonly Regex _regEx = new Regex(@"throw\s+new\s+\w+", RegexOptions.IgnoreCase | RegexOptions.Multiline);
727-
728-
/// <summary> type param regex. </summary>
729-
private static readonly Regex _typeParamRegex = new Regex(@"""\w+""");
730-
731738
/// <summary> Creates the comment exterior. </summary>
732739
/// <returns> A SyntaxTriviaList. </returns>
733740
private static SyntaxTriviaList CreateCommentExterior()

‎Manifests/vs2022/source.extension.vsixmanifest‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<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">
33
<Metadata>
4-
<Identity Id="CodeDocumentor.2022.88F29096-CA4C-4F88-A260-705D8BBFCF2A" Version="2.0.0.0" Language="en-US" Publisher="Dan Turco"/>
4+
<Identity Id="CodeDocumentor.2022.88F29096-CA4C-4F88-A260-705D8BBFCF2A" Version="2.0.1.0" Language="en-US" Publisher="Dan Turco"/>
55
<DisplayName>CodeDocumentor</DisplayName>
66
<Description xml:space="preserve">An Extension to generate XML documentation automatically using IntelliSense for interface,class,enum, field, constructor, property and method.</Description>
77
<Icon>logo.png</Icon>

0 commit comments

Comments
 (0)