All-In-One Code Framework: 微软一站式开发技术框架 示例命名规则和目录结构说明

考虑到部分All-In-One Code Framework (AIO)中的sample名字容易产生误解（比如CSSL3DeepZoom）,在此我对AIO sample命名规则和目录结构做一下说明，以方便大家使用AIO: http://cfx.codeplex.com/

AIO sample 命名规则

1. 所有sample的名字都是以编程语言的缩写开头的。

• C# sample: CSXXXXXX
• VB.NET sample: VBXXXXX
• C++ sample: CppXXXXX
• MFC sample: MFCXXXXX
• ATL sample: ATLXXXXX
• XAML sample: XAMLXXXXX

2. Sample 名字尽量用完整的名字组成，而少用缩写。 比如CSThreadSynchonization 好于 CSThreadSync。

3. Sample 名字中尽量包含该sample对应的technology的名字。比如CSWinFormDataBinding，CSSL3FullScreen。

4. 每个sample中的 “main” 源码文件名符合如下规则：

• C# sample: Program.cs
• VB.NET sample: MainModule.vb
• WinForms sample: MainForm
• WPF sample: MainWindow
• ASP.NET sample: Default.aspx
• C++ sample:  使用sample名最为“main” 源码文件名

5. Sample名中不可使用 “QuickStart”或 “HelloWorld”或 “Sample”之类的字眼。

6. Sample名不可产生歧义。比如CSDataBinding。WinForms里有DataBinding，ASP.NET里也有DataBinding。所以CSDataBinding会产生歧义。

 

AIO sample 目录结构

所有sample符合如下目录结构：

\Visual Studio 2008
    CodeFx.sln                All samples of all techs in VS2008
    CodeFx - Security.sln            Samples about security
    CodeFx - File System.sln            Samples about file system
    \Debug                    All samples output to this folder in Debug build
    \Release                    All samples output to this folder in Release build
    \CppSecurityXXX
            CppSecurityXXX.vcproj
            CppSecurityXXX.cpp
            ReadMe.txt
    \VBSecurityXXX
            VBSecurityXXX.vbproj
            MainModule.vb
            ReadMe.txt
    \CSFileSystemXXX
            CSFileSystemXXX.csproj
            Program.cs
            ReadMe.txt
\Visual Studio 2010
        CodeFx.sln

 

如果你有任何疑问或建议，欢迎在此提出。谢谢！