ColdFusion 코드의 자동 문서

Question

내 회사의 내부 웹 사이트를 실행하는 ColdFusion 소스 코드 600 개가 상속되었습니다. 내 임무 중 하나는 그것을 "문서화"하는 것입니다. 코드베이스는 약 5 년의 개발 기간을 나타내며 그 코드베이스의 기술적 사양은 없습니다.

개발자가 각 파일의 변경 로그를 유지했으며 일관된 헤더가 있습니다.

내 생각에 다양한 모듈과 참조 저장 프로 시저의 종속성 맵을 작성하여 소스 파일을 스캔하여이 문서를 쉽게 사용할 수 있습니다. 과거에 C++ 소스 코드로 Doxygen을 사용했고 ColdFusion에 이와 같은 도구가 있는지 궁금합니다.

하나의 출력 모듈 상호 관계에서 상호 의존성을 시각화하는 수단으로 xmind 파일을 만드는 기능을 연구 중입니다. 사전에

감사합니다,

크리스

Answer 1

는 당신을 heres 또한 ColdDoc

하는 UML 2 CFC 발생기를 시작할 수 있습니다.

정말로 필요한 것은 coldfusion 코드를 uml 클래스 다이어그램으로 리버스 엔지니어링하는 것입니다. 나는 내 머리 꼭대기에서 아무것도 몰라.

MagicDraw, Objecteering 아직 보이지 않습니다.

Answer 2

내 자신의 Xmind 또는 XMI 파일을 만드는 것이 나에게 좋은 방법입니다. XMI 파일은 도구간에 이식성이 더 높을 수도 있지만 마지막으로 XMI 파일 형식이 솔루션에서 작업 할 수있는 시간 동안 다소 어려웠습니다. ReFind 또는 Find를 사용하여 일관성있는 헤더의 형식을 유지하면 cfdirectory 및 cffile을 사용하여 코드 트리를 탐색하고 파일을 출력하는 스크립트를 작성할 수 있습니다.

Answer 3

ColdFusion 서버에는 모든 CFC 클래스에 대한 문서와 마찬가지로 javadoc을 출력하는 built in introspection이 있습니다.

는

관련 항목 : http://YourColdfusionServer/CFIDE/componentutils/componentdoc.cfm

그러나, 그것은 당신의 서버에 대한 RDS 로그인/암호가 필요합니다. 제 3 자에게 제공하기 위해 각 cfc 파일에 대해 cfhttp 문서를 가져 와서 페이지를 cfdocument으로 컴파일하는 재귀 스크립트를 설정했습니다.

Answer 4

자신을이 질문에 대한 답을 찾기 위해 노력 후에 나는이 솔루션을 작성 결국 :

ColdDuck

을 어쩌면 지금 너무 늦게 당신을 위해하지만, 난 그냥 단어를 확산하고 있습니다.

머레이