TFS源代码管理说明及规范.doc

源代码管理说明及规范日期撰写人版本2009-05-21 1.02009-08-10 2.0目 录1.前言32.Team Foundation Server32.1源代码管理命名语法、约定和限制32.2 TFS源代码管理项状态53.IDE开发环境选项设置64.团队项目管理65.源代码管理75.1项目源代码创建75.2项目源代码签入签出管理75.3项目源代码冲突管理76.文档管理77.未来展望81. 前言现代软件发展到前所未有的状况，一个人完成整个项目变得越来越困难。取而代之的是团队合作开发，长期以来，在团队合作软件开发过程之中，如何保证源代码的安全性，完整性，沟通性以及版本可控性一直以来是团队开发的重点。建立源代码管理规范能够帮助每个团队成员更加高效的完成项目，并且在整个软件项目开发周期之中能够及时沟通协调，确保项目的成功。2. Team Foundation ServerVisual Studio 2005 Team Foundation Server 提供了团队协作工具，使组织可以管理和跟踪软件项目的进度和状况。Team Explorer将在项目站点上发现的项目工作产品集成到 Visual Studio IDE 中，以实现有效的团队访问。Team Foundation 还提供了可扩展的工作项跟踪和企业级的版本控制系统。所有项目必须使用Team Foundation Server作为源代码管理工具。2.1源代码管理命名语法、约定和限制Team Foundation 源代码管理 具有命名语法、约定和限制。语法、约定和限制列表Team Foundation 源代码管理 具有下列命名语法、约定和限制： 名称长度： 签入说明名称的最大长度为 64 个字符。 签入策略名称的最大长度为 256 个字符。 标签名称的最大长度为 64 个字符。 工作区名称的最大长度为 64 个字符。 搁置集名称的最大长度为 64 个字符。注释长度： 签入注释的最大大小为 2GB。 签入说明值的最大大小为 2GB。 标签注释的最大长度为 2048 个字符。 搁置集注释的最大长度为 2048 个字符。 工作区注释的最大长度为 2048 个字符。 文件和路径： 服务器路径的最大长度为 259 个字符。 在 Windows 中，本地文件路径的最大长度限定为 259 个字符（包括文件名），目录的最大长度限定为 248 个字符。 Team Foundation 源代码管理 服务器中的文件没有大小限制。 Team Foundation 源代码管理 服务器中内容的总大小没有限制。 名称： Team Foundation 源代码管理 中的大多数名称不能以空格或制表符开头或结尾。除下列字符之外的任何字符都可以用于名称或标签： 尖括号 ()。 冒号 (:)。 星号 (*)。 正斜杠 (/) 和反斜杠 ()。 问号 (?)。 引号 ()。 竖线 (|)。 美元符号 ($) 不能作为文件名的第一个字符。 标签名称不能包含 ()。 工作区和搁置集名称不能包含分号 (;)。2.2 TFS源代码管理项状态图标 状态 说明 无空白表示其 Team Foundation 源代码管理 状态未知的项。已签入表示位于 Team Foundation 源代码管理 下并且没有挂起的更改的项。已签出表示当前用户在其当前工作区中具有挂起的更改的项，并且未以独占方式锁定该项。已孤立表示因依赖项中断而被孤立的项。可编辑表示可写的项。只读表示不可写的项。禁用表示因它是受源代码管理的解决方案或项目的子级而应添加到 Team Foundation 源代码管理 但未能添加的项。以独占方式签出表示当前用户在其当前工作区中具有挂起的更改的项，并且由当前用户以独占方式锁定该项。被其他用户以共享方式签出表示当前用户尚未在其当前工作区签出的项，但该项在其他工作区（由此用户或其他用户拥有）具有挂起的更改。被其他用户以独占方式签出表示当前用户尚未在其当前工作区签出的项，但该项在其他工作区（由其他用户拥有）具有挂起的更改，并且在该工作区中被独占锁定。从源代码管理中排除表示因用户已显式将其从源代码管理中排除而不在 Team Foundation 源代码管理 下的项。挂起的新项表示当前未在源代码管理服务器中但当前用户（具有添加操作的挂起的更改）正在将它添加到源代码管理的项。以同步方式打开表示 Visual Studio 正在以同步方式打开的项目所包含的项。分支表示将在下次签入期间包含在分支操作中的项。合并表示将在下次签入期间包含在合并操作中的项。挂起的删除表示将在下次签入期间从源代码管理中删除的项。挂起的撤消删除表示将在下次签入期间从源代码管理中撤消删除的项。未映射的团队项目表示当前未映射到团队项目服务器的项。未映射的文件夹表示当前未映射的文件夹中的项。已删除的文件夹表示将在下次签入期间删除的文件夹。3. IDE开发环境选项设置 Visual Studio 2005 IDE中请设置为以Visual Studio Team Foundation Server作为源代码管理工具。签入设置当中推荐按照设置为保存时自动签出,编辑时自动签出。也可根据自己的习惯自定义设置。4. 团队项目管理所有的正式项目必须由管理员在Team Foundation Server上进行创建，并同时授予团队成员对当前项目的不同权限。然后将本地项目代码签入Team Foundation Server，同时每位项目成员必须在本地保留一份代码副本。所有项目的源代码以Team Foundation Server上的代码为最近版本的代码，必须确保本地代码与服务器代码的一致性。5. 源代码管理5.1项目源代码创建授予开发团队的经理或其他负责人员为项目的系统管理员，由项目系统管理在TFS中创建项目, 并分配项目团队成员的权限。确保被授权人员才可进行源代码访问和编辑。5.2项目源代码签入签出管理Team Foundation Server上的代码必须保证能够编译通过，不能够编译通过的代码不允许签入服务器，应该保持在本地，直到调试通过之后才能签入。每次签出时，必须获取整人项目的最新版本。对公共源码文件的修改，必须通知所有项目成员。避免团队中多人负责对同一个项目文件进行同时修改；当发生多人负责同一个项目文件的情况时，签出锁定类别请选择：阻止其他用户签出和签入。每天下班之前必须签入已经能够编译通过的代码。签入代码时尽量加入注释。5.3项目源代码冲突管理当签入源代码时，如果发生冲突，即要签入的文件在服务器端已被其他用户修改。必须进行自动合并文档操作，当自动合并失败时，必须与修改人沟通，确保避免代码覆盖。6. 文档管理按公司规范，项目开发过程产生的文档必须上传至Clarity，但是在文档形成过程中的版本管理和控制必须到Team Foundation Server,每个项目文档文件夹分别按Development,Requirement,Security和Test来组织。PMO涉及的文档必须使用PMO要求的格式，其他技术相关文档可以使用自定义格式。7. 未来展望Team Foundation Server不仅是源代码管理工具，而且提供一整套项目管理功能，其功能包括工作项目管理，文档管理，项目站点动态分享，统一生成管理，源代码管理，并且能够做到与.Net代码紧密相关，提供细粒度的软件项目管理。现阶段仅使用源代码管理以及部分文档管理功能，未来将根据业务需求考虑启用其他功能。