4

I am beginning a fairly large new project using ColdFusion. This new project will include several developers and as such documentation of code will be key.

Another issue I am hoping to avoid (either with adequate code documentation or some other tool) is the duplication of code. A tool that would be able to "index" the code for searching or diagramming would likely help here.

What are others out there using either specifically for ColdFusion or language agnostic. We will likely be using ColdBox for the underlying framework if that makes a difference.

Thanks for any any all suggestions.

-c

Peter Boughton
  • 102,341
  • 30
  • 116
  • 172
cra
  • 117
  • 1
  • 9

3 Answers3

2

Well, it's impossible to tell you which framework to use without knowing more about your project, but I can list out some tools that will be useful no matter which framework you use.

Language-agnostic tools:

Coldfusion-specific tools:

Javascript-specific tools:

Ideally, your Jenkins build server should:

  • Do a fresh checkout from source control
  • Run all unit tests and stop the build if they fail
  • Generate documentation
  • Generate a production-ready package of your project

At a minimum, I highly recommend using source control, setting up Jenkins with MXunit tests, and scheduling daily automated builds.

Russ
  • 1,811
  • 1
  • 15
  • 15
  • I second using Jenkins. We use it on multiple environments and it helps our build times considerably. Also, we use it to manage our coding standards. For instance, any instance of HTMLEditFormat gets flagged and notifications are sent out (should be EncodeFor{context}). Also, ColdBox now has TestBox available as a replacement for MXUnit. – Adrian J. Moreno Feb 07 '14 at 21:56
  • It seems that the link to ColdDoc is not longer available, and the project seems to has not been updated since 2012. Are you aware of any other Coldfusion-Specific tool for generating the documentation? – Antonio Oct 01 '15 at 07:11
  • Looks like there's a relatively up-to-date fork of ColdDoc here: https://github.com/Ortus-Solutions/DocBox – Russ Oct 01 '15 at 21:18
0

We used the Atlassian suite at my last job. Mostly Jira for tracking and Greenhopper for agile but the other tools may help, fisheye, bamboo, and crucible. If you host it yourself I believe they have a one time $10/product price tag that. Depending on your team's size may or may not work. If money is no subject the suite worked really nicely. It also has built in support for svn and maybe more by now.

http://www.atlassian.com/software

Travis
  • 4,165
  • 2
  • 20
  • 31
0

Sounds to me what you need is a methodology, not a tool. If you have a clearly defined set of objects/responsibilities. There should be no crossover in scripting, and if you determine a common API for the objects being coded, I would think you'd be fine.

Nicklepedde
  • 466
  • 2
  • 10
  • Agreed. One of the reasons I am pushing for the use of an underlying framework (leaning towards ColdBox). However, the use of some kind of code documentation tool would likely be very useful. – cra Aug 23 '12 at 03:16
  • I think the best you'll find is a responsible programmer, I doubt any actual tool will do that for you. And yes I saw the ColdBox framework, but I meant beyond that you set an agreed standard for how the objects in your code are built. – Nicklepedde Aug 23 '12 at 10:49