IDesign C#编程规范（之四）
2024-07-21 02:19:27
供稿：网友
续之三，本文是idesign c#编程规范的第三章。
3 项目设置和项目结构
project settings and project structure
1. 总是以4级警告建立项目（图略）。
always build your project with warning level 4
2. 在发布版中将警告作为错误（注意这不是vs.net的缺省设置）（图略）。
treat warning as errors in release build (note that this is not the default of vs.net).
a) 虽然是可选的，本标准也推荐在调试版中将警告作为错误。
although it is optional, this standard recommend treating warnings as errors in debug builds as well.
3. 永远不要抑制特定的编译警告（图略）。
never suppress specific compiler warnings.
4. 总是在应用程序的配置文件中显式地说明支持的运行时版本。参见programming .net components第五章。
always explicitly state your supported runtime versions in the application configuration file. see chapter 5 in programming .net components.
<?xml version="1.0"?>
<configuration>
<startup>
<supportedruntime version="v2.0.0.0"/>
<supportedruntime version="v1.1.5000.0"/>
</startup>
</configuration>
5. 避免显式地自定义版本改向和绑定到clr程序集。
avoid explicit custom version redirection and binding to clr assemblies.
6. 避免显式的预编译定义(#define)。使用项目设置定义条件编译常量。
avoid explicit preprocessor definitions (#define). use the project settings for defining conditional compilation constants.
7. 不要在assemblyinfo.cs中放任何逻辑。
do not put any logic inside assemblyinfo.cs.
8. 除了在assemblyinfo.cs，不要在任何文件中放程序集属性。
do not put any assembly attributes in any file besides assemblyinfo.cs.
9. 在assemblyinfo.cs中提供所有字段，例如公司名称、描述、版权等。
populate all fields in assemblyinfo.cs such as company name, description, copyright notice.
10. 所有程序集应该使用相对路径引用。
all assembly references should use relative path.
11. 不允许在程序集中循环引用。
disallow cyclic references between assemblies.
12. 避免多模块的程序集。
avoid multi-module assemblies.
13. 缺省总是以非检查的方式运行（为了性能考虑），但是对易于溢出或下溢的操作显式使用检查模式（图略）。
always run code unchecked by default (for performance sake), but explicitly in checked mode for overflow or underflow prone operations.
int calcpower(int number,int power)
{
int result = 1;
for(int count = 1;count <= power;count++)
{
checked
{
result *= number;
}
}
return result;
}
14. 避免使用exception窗口（debug|exceptions）篡改异常处理。
avoid tampering with exception handling using the exception window (debug|exceptions).
15. 努力对同一逻辑应用程序中（通常是一个解决方案）的所有程序集和客户端使用统一的版本号。
strive to use uniform version numbers on all assemblies and clients in the same logical application (typically a solution).
16. visual studio.net应用的配置文件命名为app.config，并将其包括在项目中。
name your visual studio.net application configuration file as app.config, and include it in the project.
17. 避免使用显式代码来排除方法(#if#endif)，而是使用条件方法。
avoid explicit code exclusion of method calls (#if...#endif). use conditional methods instead.
public class myclass
{
[conditional("myspecialcondition")]
public void mymethod()
{}
}
18. 将vs.net缺省的项目结构改为标准的布局，对项目文件夹和文件应用统一的结构。
modify vs.net default project structure to your project standard layout, and apply uniform structure for project folders and files.
19. 链接一个包含所有解决方案级信息的全局共享文件（图略）。
link all solution-wide information to a global shared file:
20. 制表符选用"插入空格"，使用3个空格代替制表符。
insert spaces for tabs. use 3 spaces instead of tabs。
a) 在工具|选项|文本编辑器|c#|制表符中设置
tools|options|text editor|c#|tabs
21. 发布版中应该包含调试符号。
release build should contain debug symbols.
22. 总是对程序集签名，包括客户端应用程序。
always sign your assemblies, including the client applications.
23. 总是使用项目的snk文件对互操作程序集签名（图略）。
always sign interop assemblies with the project's snk file
（待续）
