중복 유지 보수 - 코드 및 문서 [폐쇄

문제

이것은 최고의 제목이 아닐 수도 있습니다. 누군가 내 문제를 읽은 후 누군가가 더 나은 것을 생각해 내면 감사하겠습니다. 또한, 나는 인터넷에서 스스로 가르치고 있다고 말하고 싶습니다. 그래서 내가 알지 못하는 도구가 많이있을 수 있습니다.

Java와 C#에서 FBP (Flow-Based Programming) 개념을 구현하는 소프트웨어를 유지하고 있습니다. 이들 각각에 대해 다음에 코드가 있습니다.

또한 버전 참조 및 (때로는 부분적) 설명이 있습니다.

내 웹 사이트 및 SourceForge에는 FBP 코드의 Java 버전에 대해 알아야하는 드로잉 도구도 있습니다.

모든 것이 꽤 철저히 가교되어 있지만 때로는 참조가 그리워요! 며칠 전, 나는 프로젝트에 대한 Sourceforge 뉴스를 오랫동안 업데이트하지 않았다는 것을 깨달았으므로 번잡하고 그렇게해야했습니다 :-)

나는이 차량들 중 일부가 아마도 중복 될 것이라는 것을 알고 있지만 일반적으로 누가 무엇을보고 있는지 모른다.

따라서 내 질문은이 모든 오버 헤드를 줄이는 방법이 있는지 여부입니다. 나는 아마도 Java 교차 참조를 단순화 할 수 있지만, 언어 간은 더 좋을 것입니다.

모든 아이디어는 환영받을 것입니다.

해결책

빌드/배포 프로세스의 일부로 문서를 업데이트하고 유지하려는 것 같습니다.

그렇지 않으면 당신은입니다 언제나 꼬리를 쫓을 것입니다. 분명히 문서 배포는 어디로 가고 있는지에 대한 다른 솔루션이 필요합니다 (예 : 웹 사이트에 복사, 다른 곳에서 ftped 등).

이 모든 것에 대한 만병 통치약이 있는지 확신 할 수 없습니다. Properties 파일/구성 파일의 버전 번호를 유지하고 적절한 검색/대체를 수행합니다. 코드 문서는 가능한 한 코드 자체에 들어간 다음 내 빌드에서 전처리됩니다 (위 3 단계).

당신은보고 사용 했습니까? 독사 ? 이는 다중 언어 요구 사항을 처리 할 것이며 문서 구축/유지 관리를 위해 잘 확립되어 있습니다.

다른 팁

빌드/게시 프로세스를 자동화 해야하는 것 같습니다. 나는 읽었다 이 기사 O'Reilly에 잠시 후 - 둘 다 비슷한 상황을 가지고있는 것 같습니까? 그의 솔루션은 파이썬을 많이 사용하지만 최소한 몇 가지 아이디어를 줄 수 있습니다.

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow