没有合适的资源?快使用搜索试试~ 我知道了~
首页c#编码規約日文版c#编码規約日文版
资源详情
资源评论
资源推荐
C#コーディング標準
(C) Copyright 2002 河端善博
初版 2002 年 9 月 25 日
オリジナル:http://ObjectClub.esm.co.jp/eXtremeProgramming/CodingStd.doc
http://ObjectClub.esm.co.jp/eXtremeProgramming/CodingStd VB .doc
Copyright (c) 2000,2001 Eiwa System Management, Inc. Object Club Kenji Hiranabe 21/08/05
Copyright (c) 2002 Taiyo System Corporation. Tsunefumi Nakanishi 21/08/05
Copyright (c) 2002 Yoshihiro Kawabata 21/08/05
このドキュメントは Java コーディング標準(オブジェ
クト倶楽部バージョン)、VB.NET コーディング標準を
C#用に変更したもので、フリーかつ AS-IS ベースで提
供しています。
コピー、修正、配布してかまいません。みなさんのプ
ロジェクトでこれをカスタマイズして使用することを歓
迎します。
フィードバックを歓迎します。ご意見などを以下のア
ドレスへ頂けると嬉しく思います。
フィードバック先:
extremeprogramming-jp@ObjectClub.esm.co.jp
bata@gold.ocn.ne.jp
1. 方針
このコーディング標準は、ソフトウェア開発プロジェクトにおいて C#でコーディング
する際のルール、推奨、および迷った時の指針を提供するものである。
標準策定の方針は、読みやすくメンテナンスしやすいコードを書くことである。実際の
コーディングにあたっては、プロジェクトメンバー全員がこのルールに合意しているこ
とが必要である。
実プロジェクトにおいては、このコーディング標準をカスタマイズして用いることを推
奨する。
また、あわせて .NET Framework SDK ヘルプ「クラス ライブラリ開発者向けのデザイ
ン ガイドライン」を参照することを推薦する。
※ 特に Extreme Programming プロジェクトでの利用を意識したものではなく、あら
ゆる C#を使ったプロジェクトでの利用を想定している。
2. ファイル構成
(1) ファイル名
public クラスはそのクラス名の 1 ファイルにする。
例:public class Customer は、Customer.cs に入れる。
パッケージ内の非パブリッククラスは、そのクラスが主に使われるパブリッククラスの
ファイルに含めて良い。
例外クラスは、1 ファイルに複数クラスをまとめてもよい。
Copyright (c) 2000,2001 Eiwa System Management, Inc. Object Club Kenji Hiranabe 21/08/05
Copyright (c) 2002 Taiyo System Corporation. Tsunefumi Nakanishi 21/08/05
Copyright (c) 2002 Yoshihiro Kawabata 21/08/05
2
(2) ファイルの位置
プロジェクトのルートディレクトリを決め、名前空間の “.” をディレクトリ階層に置き
換えた位置に入れる。但し、ソリューション / プロジェクトに対応している名前空間の
階層は、ソリューション名 / プロジェクト名をディレクトリ名に使用する。
例:
名前空間:
CompanyName.OrganizationName.TechnologyName.CoreFeatureName.
SubFeatureName
ソリューション SolutionName に対応する名前空間:TechnologyName
プロジェクト ProjectName に対応する名前空間:CoreFeatureName
配置先:C:\CompanyName\OrganizationName\SolutionName\
ProjectName\SubFeatureName
(3) テストクラス名
クラス ClassName のユニットテストクラス名は、ClassNameTest とする。ソリュー
ション毎テストは SolutionNameTests とする。
例:Customer クラスなら CustomerTest.cs を作成
例:CsSample ソリューションなら、CsSampleTests.csproj とする
理由:一貫性のある名前づけ。テストコードは使い方のサンプル、デモともなる。
(4) テストクラスの位置
テストクラスの位置は、被テストクラスと同じ階層のディレクトリまたはそのサブディ
レクトリに配置する。
例:
被テストクラスの位置:C:\CompanyName\OrganizationName\
Copyright (c) 2000,2001 Eiwa System Management, Inc. Object Club Kenji Hiranabe 21/08/05
Copyright (c) 2002 Taiyo System Corporation. Tsunefumi Nakanishi 21/08/05
Copyright (c) 2002 Yoshihiro Kawabata 21/08/05
3
SolutionName\ProjectName
テストクラスの位置:C:\CompanyName\OrganizationName\
SolutionName\SolutionNameTests
C:\CompanyName\OrganizationName\SolutionName\
SolutionNameTests\ProjectName
理由:物理的に近い位置でないとメンテが忘れ去られる。製品コードとの分離について
は、別のツール(NAnt の build ファイルなど)で調整可能。
3. 命名規則
(5) 名前空間
企業略式名.組織略式名.テクノロジー名.機能名を使用する。また、テクノロジー名には
ソリューションが、機能名にはプロジェクトが対応していること。
using
CompanyName.OrganizationName.TechnologyName.FeatureName
(6) ファイル名
パブリックなクラス名は、ファイル名と同じでなくてはならない。(大文字小文字の区
別を含めて)
(7) クラス名
先頭大文字。あとは区切りを大文字。
class PascalCasing
Copyright (c) 2000,2001 Eiwa System Management, Inc. Object Club Kenji Hiranabe 21/08/05
Copyright (c) 2002 Taiyo System Corporation. Tsunefumi Nakanishi 21/08/05
Copyright (c) 2002 Yoshihiro Kawabata 21/08/05
4
(8) 例外クラス名
最後を Exception としたクラス名。
class ClassNameEndsWithException
(9) インターフェイス名
クラス名に同じ。また常に最初に I を付ける。
interface INameOfInterface
また、クラスにある能力を加える様な利用の場合、その能力を示す形容詞とし、-able
を接尾にする。
例: IEnumerable, ICloneable, IXmlSerializable, …
(10) 実装クラス名
特に Interface と区別の必要があれば、最後に Impl を付ける。
class ClassNameEndsWithImpl
(11) 抽象クラス名
抽象クラス名に適当な名前が無いとき、 Abstract から始まりサブクラス名を連想させ
る名前を付ける。
abstract class AbstractBeforeSubClassName
(12) 定数(Const)
大文字もしくは大文字を “_” でつないだもの。
Copyright (c) 2000,2001 Eiwa System Management, Inc. Object Club Kenji Hiranabe 21/08/05
Copyright (c) 2002 Taiyo System Corporation. Tsunefumi Nakanishi 21/08/05
Copyright (c) 2002 Yoshihiro Kawabata 21/08/05
5
剩余27页未读,继续阅读
calvincui
- 粉丝: 2
- 资源: 6
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- RTL8188FU-Linux-v5.7.4.2-36687.20200602.tar(20765).gz
- c++校园超市商品信息管理系统课程设计说明书(含源代码) (2).pdf
- 建筑供配电系统相关课件.pptx
- 企业管理规章制度及管理模式.doc
- vb打开摄像头.doc
- 云计算-可信计算中认证协议改进方案.pdf
- [详细完整版]单片机编程4.ppt
- c语言常用算法.pdf
- c++经典程序代码大全.pdf
- 单片机数字时钟资料.doc
- 11项目管理前沿1.0.pptx
- 基于ssm的“魅力”繁峙宣传网站的设计与实现论文.doc
- 智慧交通综合解决方案.pptx
- 建筑防潮设计-PowerPointPresentati.pptx
- SPC统计过程控制程序.pptx
- SPC统计方法基础知识.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论2