我想知道在项目中组织构建资产和源代码的流行或最佳方式是什么?
9 回答
我有
/src - source files (test files are within a package 'test' here, or 'test' subpackage of what is being tested)
/lib - required libraries
/doc - text documentation and development notes
/build - where we build (each separate build item within a subfolder here)
/conf - configurations (each config, production, test, developer, etc gets a folder in here, and when building Jars and Wars the correct set is copied across)
/extras - other stuff
/extras/resources - resources that should be included within generated Jars, e.g., icons
和
/websites - Web related content and configurations (each website in its own folder here)
/websites/$site/webcontent - All the web content here
/websites/$site/conf - website related configuration files here (instead of /conf)
/websites/$site/build.xml - ANT build script for website that creates a war, etc
(remember you might have an admin site and a public site for a single project, hence the multi-site configuration within a single project, or even site v1 and site v2, etc)
最后,您必须根据项目本身以及您使用的是 ANT 还是 Maven 有点灵活。我使用 ANT,或者将 ANT 脚本放在 /build 中,但它们已经出现在某些项目的其他地方(例如在 /websites/ 中)。
一般来说:
src/ - source files
src/tests - unit tests
doc/ - documentation
res/ - static resources (textures, locale database, level definitions etc)
build/ - tools needed to build the system
project specific libraries and compilers
Makefile - the makefile (make, test, clean etc)
例如,我将以下内容用于我的 .Net 风格项目;
/build/reports - reports and logs from the build process
/build/artifacts - all output of the build process is copied here
/src/ - all solution source code
/lib/ - 3rd party or other build dependencies
/tools/... - all other helper tools used in the build process
/tools/nant - example tool
/tools/nunit - example tool
/myProject.sln - visual studio solution file (or other IDE)
/default.build - nant build file
由于我只处理 Java 项目,并且它们都是“Mavenized”,因此我使用Maven 为项目结构定义的约定。
基本上:
project
src/main/java --> source files
src/main/resources --> resources files (*.xml, *.properties, etc.)
src/test/java --> source files for tests.
src/test/resources --> resources files for tests.
此文件夹组织代表xLim 概念的演变。
您可以在这个开源项目中查看它。
Build - ignored from version control
Artifact - build artifacts (grabbed by CC.NET from here)
Package - generated zip or install packages
Test - all assemblies for unit tests
Help - autogenerated documentation
Resource
Build - plugins and extensions for NAnt/MSBuild
Library - 3rd party dependencies
Tool
FxCop
ILMerge
NCover
NCoverExplorer
NUnit
SHFB
Wix
Samples
SampleProject1
SampleProject2
Source
Project1
Project2
GlobalAssemblyInfo.cs
VersionAssemblyInfo.cs - integration server updates this one
Test
Project1.Tests
Project2.Tests
Solution.build - primary build file
Solution.ccnet - CruiseControl adapter for the build file
Solution.sln - Visual Studio
go.cmd - shortcut for launching the build file locally
readme.txt - licenses and overview
SharedKey.snk - for strong naming
我个人使用
/client/projectname/trunk/source/Solution Name.sln
/client/projectname/trunk/source/Project.One
/client/projectname/trunk/source/Project.Two
/client/projectname/trunk/source/Project.Three
/client/projectname/trunk/source/SQL/
/client/projectname/trunk/source/SQL/SomeScript.sql
/client/projectname/trunk/libraries
/client/projectname/trunk/resources/Nunit
/client/projectname/trunk/resources/LLBLGEN
/client/projectname/trunk/documentation
/client/projectname/trunk/builds
它对我们来说很好,但我认为这不是最好的。如果是关于 .net,您还可以查看treesurgeon他们将其描述为:
你有没有花几天时间建立一个新的开发树?你有没有花几天时间设置几个开发树?您是否甚至花了数周时间尝试使用一组最佳实践来完善您的所有开发树?
如果上述任何一个答案的答案是“是”,那么您会喜欢 Tree Surgeon!
Tree Surgeon 是一个 .NET 开发树生成器。只需给它您的项目名称,它就会在几秒钟内为您建立一个开发树。不仅如此,您的新树还内置了多年积累的构建工程经验。
我喜欢Netbeans IDE 组织项目的方式。只需启动一个新项目,它就会设置一个默认的开发树和一个 ant 脚本。
对我来说,这取决于项目规模。对于小型项目,我发现具有单个 Makefile、/src 和 /include 目录的项目目录效果很好。
对于 .NET 项目,请查看ProjectScaffold并在此要点下进行讨论。