GitLab Commit is coming up on August 3-4. Learn how to innovate together using GitLab, the DevOps platform. Register for free: gitlabcommitvirtual2021.com

Commit d77d8b2e authored by Mike Ishida's avatar Mike Ishida
Browse files

Addded new comments on User and Product class.

parent de34443c
Pipeline #11587503 passed with stages
in 5 minutes and 16 seconds
......@@ -5,7 +5,7 @@
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DocumentationFile>wwwroot\MySampleWebApi.xml</DocumentationFile>
<DocumentationFile>MySampleWebApi.xml</DocumentationFile>
</PropertyGroup>
<ItemGroup>
......
......@@ -78,5 +78,51 @@
</summary>
<param name="id"></param>
</member>
<member name="P:MySampleWebApi.Resources.Product.id">
<summary>
商品のIdentity
</summary>
</member>
<member name="P:MySampleWebApi.Resources.Product.ProdCd">
<summary>
商品コード(カタログ上のコード)
</summary>
</member>
<member name="P:MySampleWebApi.Resources.Product.ProdName">
<summary>
商品名称
</summary>
</member>
<member name="P:MySampleWebApi.Resources.Product.Price">
<summary>
現在の価格
</summary>
</member>
<member name="P:MySampleWebApi.Resources.Product.CreatedAt">
<summary>
登録日
</summary>
</member>
<member name="P:MySampleWebApi.Resources.User.id">
<summary>
ユーザーのIdentity
</summary>
</member>
<member name="P:MySampleWebApi.Resources.User.Name">
<summary>
ユーザー名
</summary>
</member>
<member name="P:MySampleWebApi.Resources.User.Email">
<summary>
ユーザーのメールアドレス
各種通知メッセージがこのアドレスに送られる。
</summary>
</member>
<member name="P:MySampleWebApi.Resources.User.CreatedAt">
<summary>
登録日時
</summary>
</member>
</members>
</doc>
......@@ -7,10 +7,29 @@ namespace MySampleWebApi.Resources
{
public class Product
{
/// <summary>
/// 商品のIdentity
/// </summary>
public long id { get; set; }
/// <summary>
/// 商品コード(カタログ上のコード)
/// </summary>
public string ProdCd { get; set; }
/// <summary>
/// 商品名称
/// </summary>
public string ProdName { get; set; }
/// <summary>
/// 現在の価格
/// </summary>
public decimal Price { get; set; }
/// <summary>
/// 登録日
/// </summary>
public DateTime CreatedAt { get; set; }
}
......
......@@ -7,9 +7,25 @@ namespace MySampleWebApi.Resources
{
public class User
{
/// <summary>
/// ユーザーのIdentity
/// </summary>
public long id { get; set; }
/// <summary>
/// ユーザー名
/// </summary>
public string Name { get; set; }
/// <summary>
/// ユーザーのメールアドレス
/// 各種通知メッセージがこのアドレスに送られる。
/// </summary>
public string Email { get; set; }
/// <summary>
/// 登録日時
/// </summary>
public DateTime CreatedAt { get; set; }
}
......
<?xml version="1.0"?>
<doc>
<assembly>
<name>MySampleWebApi</name>
</assembly>
<members>
<member name="T:MySampleWebApi.Controllers.ProductsController">
<summary>
商品の検索・変更用APIコントローラ。
</summary>
</member>
<member name="M:MySampleWebApi.Controllers.ProductsController.Get">
<summary>
商品の一覧を返す。
</summary>
<returns></returns>
</member>
<member name="M:MySampleWebApi.Controllers.ProductsController.Get(System.Int64)">
<summary>
指定されたIdを持つ商品を返す。
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:MySampleWebApi.Controllers.ProductsController.Post(MySampleWebApi.Resources.Product)">
<summary>
商品を新規登録する。
</summary>
<param name="product"></param>
</member>
<member name="M:MySampleWebApi.Controllers.ProductsController.Put(System.Int32,MySampleWebApi.Resources.Product)">
<summary>
商品を更新する。
</summary>
<param name="id"></param>
<param name="product"></param>
</member>
<member name="M:MySampleWebApi.Controllers.ProductsController.Delete(System.Int64)">
<summary>
商品を削除する。
</summary>
<param name="id"></param>
</member>
<member name="T:MySampleWebApi.Controllers.UsersController">
<summary>
ユーザーの検索・変更用APIコントローラ。
</summary>
</member>
<member name="M:MySampleWebApi.Controllers.UsersController.Get">
<summary>
ユーザーの一覧を返す。
</summary>
<returns></returns>
</member>
<member name="M:MySampleWebApi.Controllers.UsersController.Get(System.Int64)">
<summary>
指定されたIdを持つユーザーを返す。
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:MySampleWebApi.Controllers.UsersController.Post(MySampleWebApi.Resources.User)">
<summary>
ユーザーを新規登録する。
</summary>
<param name="user"></param>
</member>
<member name="M:MySampleWebApi.Controllers.UsersController.Put(System.Int64,MySampleWebApi.Resources.User)">
<summary>
ユーザーを更新する。
</summary>
<param name="id"></param>
<param name="user"></param>
</member>
<member name="M:MySampleWebApi.Controllers.UsersController.Delete(System.Int64)">
<summary>
ユーザーを削除する。
</summary>
<param name="id"></param>
</member>
</members>
</doc>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment