Skip to content
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.

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

XMLコメントの文体を統一する #2239

Merged
merged 4 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
namespace Dressca.Web.Dto.ServerTime;

/// <summary>
/// サーバー時間のレスポンスデータを表します。
/// サーバー時間のレスポンスデータを表します。
/// </summary>
public class ServerTimeResponse
{
/// <summary>
/// サーバー時間
/// サーバー時間を取得または設定します
/// </summary>
[Required]
public string ServerTime { get; set; } = string.Empty;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
namespace Dressca.Web.Dto.Users;

/// <summary>
/// ユーザー情報のレスポンスデータを表します。
/// ユーザー情報のレスポンスデータを表します。
/// </summary>
public class UserResponse
{
/// <summary>
/// ユーザー ID を取得または設定します。
/// ユーザー ID を取得または設定します。
/// </summary>
[Required]
public string UserId { get; set; } = string.Empty;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
namespace Dressca.Web.Configuration;

/// <summary>
/// アプリケーション構成設定の WebServerOptions です。
/// アプリケーション構成設定の WebServerOptions です。
/// </summary>
public class WebServerOptions
{
/// <summary>
/// 許可するオリジンを取得または設定します。
/// 許可するオリジンを取得または設定します。
/// </summary>
public string[] AllowedOrigins { get; set; } = [];
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace Dressca.Web.Controllers;

/// <summary>
/// サーバー時間に関する情報にアクセスする API コントローラーです。
/// サーバー時間に関する情報にアクセスする API コントローラーです。
/// </summary>
[Route("api/servertime")]
[ApiController]
Expand All @@ -16,7 +16,7 @@ public class ServerTimeController : ControllerBase
private readonly TimeProvider timeProvider;

/// <summary>
/// <see cref="ServerTimeController"/> の新しいインスタンスを作成します。
/// <see cref="ServerTimeController"/> の新しいインスタンスを作成します。
/// </summary>
/// <param name="logger">ロガー。</param>
public ServerTimeController(ILogger<ServerTimeController> logger)
Expand All @@ -25,7 +25,7 @@ public ServerTimeController(ILogger<ServerTimeController> logger)
}

/// <summary>
/// <see cref="ServerTimeController"/> の新しいインスタンスを作成します。
/// <see cref="ServerTimeController"/> の新しいインスタンスを作成します。
/// </summary>
/// <param name="logger">ロガー。</param>
/// <param name="timeProvider">タイムプロバイダー。</param>
Expand All @@ -36,7 +36,7 @@ internal ServerTimeController(ILogger<ServerTimeController> logger, TimeProvider
}

/// <summary>
/// 認証不要で現在のサーバー時間を取得します。
/// 認証不要で現在のサーバー時間を取得します。
/// </summary>
/// <returns>サーバー時間。</returns>
[HttpGet]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
namespace Dressca.Web.Controllers;

/// <summary>
/// ユーザーに関連する情報にアクセスする API コントローラーです。
/// ユーザーに関連する情報にアクセスする API コントローラーです。
/// </summary>
[Route("api/users")]
[ApiController]
[Produces("application/json")]
public class UsersController : ControllerBase
{
/// <summary>
/// 認証済みユーザーのユーザー情報を取得します。
/// 認証済みユーザーのユーザー情報を取得します。
/// </summary>
/// <returns>ユーザー情報。</returns>
/// <response code="200">成功。</response>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
namespace Maris.ConsoleApp.Core;

/// <summary>
/// イベントIDを管理するクラスです
/// イベント ID を管理するクラスです
/// </summary>
internal class Events
{
/// <summary>
/// デバッグ用のイベントID
/// デバッグ用のイベント ID
/// </summary>
internal static readonly EventId DebugEvent = new(9999, nameof(DebugEvent));
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ internal static class StringExtensions
/// <paramref name="value"/> に指定した文字列のプレースホルダーを
/// <paramref name="args"/> の値で埋めた文字列を返却します。
/// </summary>
/// <param name="value">プレースホルダを含む文字列。</param>
/// <param name="args">プレースホルダを埋める値。</param>
/// <param name="value">プレースホルダーを含む文字列。</param>
/// <param name="args">プレースホルダーを埋める値。</param>
/// <returns>プレースホルダーを埋めた文字列。</returns>
internal static string Embed(this string value, params object?[] args)
=> string.Format(value, args);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,37 @@
namespace Maris.ConsoleApp.Hosting;

/// <summary>
/// イベントIDを管理するクラスです
/// イベント ID を管理するクラスです
/// </summary>
internal class Events
{
/// <summary>
/// パラメータのパースの開始を示すイベントID
/// パラメータのパースの開始を示すイベント ID
/// </summary>
internal static readonly EventId StartParseParameter = new(1001, nameof(StartParseParameter));

/// <summary>
/// ホスティングサービスの開始を示すイベントID
/// ホスティングサービスの開始を示すイベント ID
/// </summary>
internal static readonly EventId StartHostingService = new(1101, nameof(StartHostingService));

/// <summary>
/// 不正なパラメータが検出されたことを示すイベントID
/// 不正なパラメータが検出されたことを示すイベント ID
/// </summary>
internal static readonly EventId InvalidParameterDetected = new(1102, nameof(InvalidParameterDetected));

/// <summary>
/// コマンドの実行時に例外が発生したことを示すイベントID
/// コマンドの実行時に例外が発生したことを示すイベント ID
/// </summary>
internal static readonly EventId CommandExecutorRaiseException = new(1103, nameof(CommandExecutorRaiseException));

/// <summary>
/// ホスティングサービスの終了を示すイベントID
/// ホスティングサービスの終了を示すイベント ID
/// </summary>
internal static readonly EventId StopHostingService = new(1104, nameof(StopHostingService));

/// <summary>
/// デバッグ用のイベントID
/// デバッグ用のイベント ID
/// </summary>
internal static readonly EventId DebugEvent = new(9999, nameof(DebugEvent));
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Maris.Samples.ApplicationCore;

/// <summary>
/// イベントIDを管理するクラスです
/// イベント ID を管理するクラスです
/// </summary>
internal class Events
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public class CommandResult : ICommandResult
public static ICommandResult CreateError(int exitCode) => new ErrorCommandResult(exitCode);

/// <summary>
/// 警告終了を表す <see cref="CommandResult"/> 。
/// 警告終了を表す <see cref="CommandResult"/> です
/// </summary>
private class WarningCommandResult : CommandResult
{
Expand Down Expand Up @@ -104,7 +104,7 @@ internal WarningCommandResult(int exitCode) : base(exitCode)
}

/// <summary>
/// 異常終了を表す <see cref="CommandResult"/> 。
/// 異常終了を表す <see cref="CommandResult"/> です
/// </summary>
private class ErrorCommandResult : CommandResult
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Maris.Samples.Cli;

/// <summary>
/// イベントIDを管理するクラスです
/// イベント ID を管理するクラスです
/// </summary>
internal class Events
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,23 +83,23 @@ public CatalogApplicationService(
}

/// <summary>
/// フィルタリング用のカタログブランドリストを取得します。
/// フィルタリング用のカタログブランドリストを取得します。
/// </summary>
/// <param name="cancellationToken">キャンセルトークン。</param>
/// <returns>カタログブランドリストを返す非同期処理を表すタスク。</returns>
public Task<IReadOnlyList<CatalogBrand>> GetBrandsAsync(CancellationToken cancellationToken = default)
=> this.brandRepository.GetAllAsync(cancellationToken);

/// <summary>
/// フィルタリング用のカタログカテゴリリストを取得します。
/// フィルタリング用のカタログカテゴリリストを取得します。
/// </summary>
/// <param name="cancellationToken">キャンセルトークン。</param>
/// <returns>カタログカテゴリリストを返す非同期処理を表すタスク。</returns>
public Task<IReadOnlyList<CatalogCategory>> GetCategoriesAsync(CancellationToken cancellationToken = default)
=> this.categoryRepository.GetAllAsync(cancellationToken);

/// <summary>
/// カタログにアイテムを追加します。
/// カタログにアイテムを追加します。
/// </summary>
/// <param name="name">商品名。</param>
/// <param name="description">説明。</param>
Expand Down Expand Up @@ -162,7 +162,7 @@ public async Task<CatalogItem> AddItemToCatalogAsync(
}

/// <summary>
/// カタログからアイテムを削除します。
/// カタログからアイテムを削除します。
/// </summary>
/// <param name="id">削除対象のカタログアイテムの ID 。</param>
/// <param name="rowVersion">削除対象のカタログアイテムの行バージョン。</param>
Expand Down Expand Up @@ -195,7 +195,7 @@ public async Task DeleteItemFromCatalogAsync(long id, byte[] rowVersion, Cancell
}

/// <summary>
/// カタログアイテムを更新します。
/// カタログアイテムを更新します。
/// </summary>
/// <param name="id">カタログアイテム ID 。</param>
/// <param name="name">商品名。</param>
Expand Down Expand Up @@ -303,7 +303,7 @@ public async Task UpdateCatalogItemAsync(
}

/// <summary>
/// 管理者が指定したID のカタログアイテムを取得します。
/// 管理者が指定した ID のカタログアイテムを取得します。
/// </summary>
/// <param name="catalogItemId">カタログアイテム ID 。</param>
/// <param name="cancellationToken">キャンセルトークン。</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Dressca.ApplicationCore.Assets;

/// <summary>
/// アセットエンティティ
/// アセットを表現するエンティティです
/// </summary>
public class Asset
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Dressca.ApplicationCore.Assets;

/// <summary>
/// アセットリポジトリ
/// アセットの情報にアクセスするリポジトリです
/// </summary>
public interface IAssetRepository
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Dressca.ApplicationCore.Assets;

/// <summary>
/// アセットのストア
/// ファイルシステム上のアセット情報を取得する機能を提供します
/// </summary>
public interface IAssetStore
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Dressca.ApplicationCore.Baskets;

/// <summary>
/// 買い物かごエンティティ
/// 買い物かごを表現するエンティティです
/// </summary>
public class Basket
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Dressca.ApplicationCore.Baskets;

/// <summary>
/// 買い物かごアイテムです
/// 買い物かごアイテムを表現するエンティティです
/// </summary>
public class BasketItem
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Dressca.ApplicationCore.Baskets;

/// <summary>
/// 買い物かごリポジトリインターフェース
/// 買い物かごの情報にアクセスするリポジトリです
/// </summary>
public interface IBasketRepository
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Dressca.ApplicationCore.Catalog;

/// <summary>
/// カタログに関するドメインサービスを提供します
/// カタログに関するドメインサービスの実装です
/// </summary>
internal class CatalogDomainService : ICatalogDomainService
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Dressca.ApplicationCore.Catalog;

/// <summary>
/// カタログブランドリポジトリ
/// カタログブランドの情報にアクセスするリポジトリです
/// </summary>
public interface ICatalogBrandRepository
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Dressca.ApplicationCore.Catalog;

/// <summary>
/// カタログブランドリポジトリ
/// カタログカテゴリの情報にアクセスするリポジトリです
/// </summary>
public interface ICatalogCategoryRepository
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Dressca.ApplicationCore.Catalog;

/// <summary>
/// カタログドメインサービス
/// カタログに関するドメインサービスを提供します
/// </summary>
public interface ICatalogDomainService
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Dressca.ApplicationCore.Catalog;

/// <summary>
/// カタログリポジトリ
/// カタログの情報にアクセスするリポジトリです
/// </summary>
public interface ICatalogRepository
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Dressca.ApplicationCore.Ordering;

/// <summary>
/// 注文エンティティのファクトリー
/// 注文エンティティを生成するファクトリーです
/// </summary>
public interface IOrderFactory
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Dressca.ApplicationCore.Ordering;

/// <summary>
/// 注文リポジトリ
/// 注文の情報にアクセスするリポジトリです
/// </summary>
public interface IOrderRepository
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
namespace Dressca.ApplicationCore.Ordering;

/// <summary>
/// 注文エンティティ
/// 注文を表現するエンティティです
/// </summary>
public class Order
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
namespace Dressca.ApplicationCore.Ordering;

/// <summary>
/// 注文エンティティを生成するファクトリークラス
/// 注文エンティティファクトリーの実装です
/// </summary>
internal class OrderFactory : IOrderFactory
{
Expand Down
Loading
Loading