Skip to content

Remove redundant comments #4594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Remove redundant comments #4594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c366c4f
.
SimonCropp Mar 13, 2025
48eff95
.
SimonCropp Mar 13, 2025
5dd500e
.
SimonCropp Mar 13, 2025
523a59f
.
SimonCropp Mar 13, 2025
0643008
.
SimonCropp Mar 14, 2025
7fb292d
.
SimonCropp Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions Samples/BlazorExample/BlazorExample/BlazorExample/Controllers/CslaStateController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ namespace BlazorExample.Controllers
/// Gets and puts the current user session data
/// from the Blazor wasm client components.
/// </summary>
/// <param name="applicationContext"></param>
/// <param name="sessionManager"></param>
[ApiController]
[Route("[controller]")]
public class CslaStateController(ApplicationContext applicationContext, ISessionManager sessionManager) :
Expand Down
2 changes: 0 additions & 2 deletions Samples/ProjectTracker/ProjectTracker.AppServer/Controllers/CslaStateController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ namespace ProjectTracker.AppServer.Controllers
/// Gets and puts the current user session data
/// from the Blazor wasm client components.
/// </summary>
/// <param name="applicationContext"></param>
/// <param name="sessionManager"></param>
[ApiController]
[Route("[controller]")]
public class CslaStateController(ApplicationContext applicationContext, ISessionManager sessionManager) :
Expand Down
2 changes: 0 additions & 2 deletions ...ectTracker/ProjectTracker.Blazor/ProjectTracker.Blazor/Controllers/CslaStateController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ namespace ProjectTracker.Blazor.Controllers
/// Gets and puts the current user session data
/// from the Blazor wasm client components.
/// </summary>
/// <param name="applicationContext"></param>
/// <param name="sessionManager"></param>
[ApiController]
[Route("[controller]")]
public class CslaStateController(ApplicationContext applicationContext, ISessionManager sessionManager) :
Expand Down
1 change: 0 additions & 1 deletion Samples/ProjectTracker/ProjectTracker.DalEfCore/ConfigurationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ public static class ConfigurationExtensions
/// Add the services for ProjectTracker.Dal that
/// use Entity Framework
/// </summary>
/// <param name="services"></param>
public static void AddDalEfCore(this IServiceCollection services)
{
services.AddScoped<PTrackerContext>();
Expand Down
1 change: 0 additions & 1 deletion Samples/ProjectTracker/ProjectTracker.DalMock/ConfigurationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ public static class ConfigurationExtensions
/// Add the services for ProjectTracker.Dal that
/// use Entity Framework
/// </summary>
/// <param name="services"></param>
public static void AddDalMock(this IServiceCollection services)
{
services.AddTransient<IAssignmentDal, AssignmentDal>();
Expand Down
2 changes: 0 additions & 2 deletions Samples/RuleTutorial/RuleTutorial.Testing.Common/BusinessRuleTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,7 @@ private async Task ExecuteRuleAsync(IBusinessRuleAsync rule, RuleContext context
/// <summary>
/// Gets the output property value.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="propertyInfo">The property info.</param>
/// <returns></returns>
public T GetOutputPropertyValue<T>(PropertyInfo<T> propertyInfo)
{
return (T)RuleContext.OutputPropertyValues[propertyInfo];
Expand Down
10 changes: 0 additions & 10 deletions ...la.Analyzers/Csla.Analyzers/AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer
: DiagnosticAnalyzer
Expand All @@ -23,16 +20,9 @@ public sealed class AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer
helpLinkUri: HelpUrlBuilder.Build(
Constants.AnalyzerIdentifiers.AsynchronousBusinessRuleInheritance, nameof(AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer)));

/// <summary>
///
/// </summary>
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics =>
ImmutableArray.Create(inheritsFromBusinessRuleRule);

/// <summary>
///
/// </summary>
/// <param name="context"></param>
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
Expand Down
16 changes: 1 addition & 15 deletions ...ers/Csla.Analyzers/AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzerConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,15 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
public static class AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzerConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>

public static readonly LocalizableResourceString Message = new(nameof(Resources.AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class AsynchronousBusinessRuleInheritingFromBusinessRuleChangeToBusinessRuleAsyncCodeFixConstants
{
/// <summary>
///
/// </summary>
public static string UpdateToAsyncEquivalentsDescription => Resources.AsynchronousBusinessRuleInheritingFromBusinessRuleAnalyzer_UpdateToAsyncEquivalentsDescription;
}
}
17 changes: 2 additions & 15 deletions ...ers/AsynchronousBusinessRuleInheritingFromBusinessRuleChangeToBusinessRuleAsyncCodeFix.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,16 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[ExportCodeFixProvider(LanguageNames.CSharp)]
[Shared]
public sealed class AsynchronousBusinessRuleInheritingFromBusinessRuleChangeToBusinessRuleAsyncCodeFix
: CodeFixProvider
{
/// <summary>
///
/// </summary>
public override ImmutableArray<string> FixableDiagnosticIds =>
ImmutableArray.Create(AnalyzerIdentifiers.AsynchronousBusinessRuleInheritance);
/// <summary>
///
/// </summary>
/// <returns></returns>

public sealed override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;
/// <summary>
///
/// </summary>
/// <param name="context"></param>
/// <returns></returns>

public override async Task RegisterCodeFixesAsync(CodeFixContext context)
{
var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
Expand Down
10 changes: 0 additions & 10 deletions Source/Csla.Analyzers/Csla.Analyzers/BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer
: DiagnosticAnalyzer
Expand All @@ -23,16 +20,9 @@ public sealed class BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer
helpLinkUri: HelpUrlBuilder.Build(
Constants.AnalyzerIdentifiers.BusinessRuleContextUsage, nameof(BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer)));

/// <summary>
///
/// </summary>
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics =>
ImmutableArray.Create(usesAddMethodsOnContextRule);

/// <summary>
///
/// </summary>
/// <param name="context"></param>
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
Expand Down
10 changes: 1 addition & 9 deletions ...la.Analyzers/Csla.Analyzers/BusinessRuleDoesNotUseAddMethodsOnContextAnalyzerConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,10 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
public static class BusinessRuleDoesNotUseAddMethodsOnContextAnalyzerConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>

public static readonly LocalizableResourceString Message = new(nameof(Resources.BusinessRuleDoesNotUseAddMethodsOnContextAnalyzer_Message), Resources.ResourceManager, typeof(Resources));
}
}
10 changes: 0 additions & 10 deletions Source/Csla.Analyzers/Csla.Analyzers/CheckConstructorsAnalyzer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[DiagnosticAnalyzer(LanguageNames.CSharp)]
public sealed class CheckConstructorsAnalyzer
: DiagnosticAnalyzer
Expand All @@ -29,19 +26,12 @@ public sealed class CheckConstructorsAnalyzer
helpLinkUri: HelpUrlBuilder.Build(
Constants.AnalyzerIdentifiers.ConstructorHasParameters, nameof(CheckConstructorsAnalyzer)));

/// <summary>
///
/// </summary>
public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics =>
[
publicNoArgumentConstructorIsMissingRule,
constructorHasParametersRule
];

/// <summary>
///
/// </summary>
/// <param name="context"></param>
public override void Initialize(AnalysisContext context)
{
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
Expand Down
44 changes: 5 additions & 39 deletions Source/Csla.Analyzers/Csla.Analyzers/CheckConstructorsAnalyzerConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,67 +3,33 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
public static class PublicNoArgumentConstructorIsMissingConstants
{
/// <summary>
///
/// </summary>
public const string HasNonPublicNoArgumentConstructor = "HasNonPublicNoArgumentConstructor";
/// <summary>
///
/// </summary>

public static readonly LocalizableResourceString Title = new(nameof(Resources.PublicNoArgumentConstructorIsMissing_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>

public static readonly LocalizableResourceString Message = new(nameof(Resources.PublicNoArgumentConstructorIsMissing_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class ConstructorHasParametersConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.ConstructorHasParameters_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>

public static readonly LocalizableResourceString Message = new(nameof(Resources.ConstructorHasParameters_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class FindBusinessObjectCreationConstants
{
/// <summary>
///
/// </summary>
public static readonly LocalizableResourceString Title = new(nameof(Resources.FindBusinessObjectCreationConstants_Title), Resources.ResourceManager, typeof(Resources));
/// <summary>
///
/// </summary>

public static readonly LocalizableResourceString Message = new(nameof(Resources.FindBusinessObjectCreationConstants_Message), Resources.ResourceManager, typeof(Resources));
}

/// <summary>
///
/// </summary>
public static class CheckConstructorsAnalyzerPublicConstructorCodeFixConstants
{
/// <summary>
///
/// </summary>
public static string AddPublicConstructorDescription => Resources.CheckConstructorsAnalyzerPublicConstructor_AddPublicConstructorDescription;
/// <summary>
///
/// </summary>

public static string UpdateNonPublicConstructorToPublicDescription => Resources.CheckConstructorsAnalyzerPublicConstructor_UpdateNonPublicConstructorToPublicDescription;
}
}
12 changes: 0 additions & 12 deletions Source/Csla.Analyzers/Csla.Analyzers/CheckConstructorsAnalyzerPublicConstructorCodeFix.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,16 @@

namespace Csla.Analyzers
{
/// <summary>
///
/// </summary>
[ExportCodeFixProvider(LanguageNames.CSharp)]
[Shared]
public sealed class CheckConstructorsAnalyzerPublicConstructorCodeFix
: CodeFixProvider
{
/// <summary>
///
/// </summary>
public override ImmutableArray<string> FixableDiagnosticIds =>
ImmutableArray.Create(Constants.AnalyzerIdentifiers.PublicNoArgumentConstructorIsMissing);

/// <summary>
///
/// </summary>
public sealed override FixAllProvider GetFixAllProvider() => WellKnownFixAllProviders.BatchFixer;

/// <summary>
///
/// </summary>
public override async Task RegisterCodeFixesAsync(CodeFixContext context)
{
var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
Expand Down
Loading
Loading