Bir kod akış şeması yazmak için Öneriler

6 Cevap php

Ben bu yaz staj sonuna yaklaşıyor, ve ben öncelikle PHP, MySQL, JavaScript (jQuery) içerir akıl hocalarım için bir araç geliştirdik. Herkes programı ve dosyalar arasındaki ilişkilerin kod yapısını gösteren belge okumak için kolay oluşturmaya herhangi bir şablon ya da önerileriniz ya da bağlantıları var mı?

Bu adamlar programcılar vardır, ama yukarıdaki herhangi bir dilde çok deneyim olmadı, bu yüzden nispeten basit olmak istiyorum.


Edit:

Akış şeması bir tür (mantıklı) gitmek için yolu gibi görünüyor. Bir sayfadaki her sınıf dosyası ile başlar? Yoksa tek tek başlayın ve her ayrıntıyı anlamaya ve daha karmaşık alır gibi yeniden düzenleyerek, dışarı şube yok.

6 Cevap

Herhangi bir ücretsiz UML araçları için arama veya Microsoft Visio erişiminiz varsa UML diyagramlar oluşturmak için kullanabilirsiniz.

Zihin Haritalama burada bazı yardımcı olabilir, ben FreeMind veya XMind gibi, tavsiye bazı ücretsiz araçlar vardır.

Ben yazılım (fonksiyonel özellikleri), ve nasıl inşa etmek, ve bunu test etmek için ne anlatarak başlamak istiyorum: http://stackoverflow.com/questions/400382

Bunu yaptıktan sonra, kaynak kodu yardımı bit işlevsellik hangi bit uygulamak için hangi belirlemek için, kaynak koduna içine fonksiyonel spec işaretçileri ekleyebilirsiniz.

[I 'pointer' derken, demek ki / URL'leri ve / veya ilgili kaynak kodunun isimlerini ekleyebilir, bazı işlevleri açıklanır tanımlayan bir bölümünde.]

PHP belgeleri işaretlemek yapar ki, Doxygen kontrol edebilirsiniz. Nokta varsa, Doxygen otomatik olarak, dosyalar için bağımlılık grafikler oluşturmak yanı sıra sınıflar için fonksiyonlar için grafikler ve soy grafikler arayabilirsiniz.

Ancak, Doxygen MySQL kaynağını belgelemek için herhangi bir kesin desteği yok. Bazı popüler perl komut olsa, Javascript kodu belgelemek için olduğunu görünür.

Sen some sample Doxygen-generated documentation de görmek ilginizi çekebilir.

Ben OmniGraffle kullanmanızı öneririz. Bu bir OS X uygulama, ama phenominal bulunuyor.

http://www.omnigroup.com/applications/OmniGraffle/

Benim birçok proje için yaptık. Varolan bir üzerinde çalışmaya başladığınızda, aslında, şimdi benim kendi referans için akış şeması çeşit yapmak ve daha sonra depoya kontrol öğrendim.

(Belki aklınızdaki ne ek olarak) diyagram bir akış şeması türü tercih. Ben sadece Open Office kullanmak vb daireler, dikdörtgenler, üçgenler, çizmek, çeşitli parçaları için & kararlar. Eğer biri yapmak ve sonra gerektiği şekilde metni değiştirerek, kopyalamak, bu çok zaman alıcı değil. Oklarla aynı, sadece onlardan bir sürü sonra istediğiniz yere etrafında hareket yapmak.

Ben bunu yapan bir aracı arıyor denedim ama OO daha kullanımı önemli ölçüde daha kolay eğer o adamcağız ve kaza olma eğilimindedir. Kararlı ise, herhangi bir kopyası daha hızlı değil ve OO yaptığı gibi belki de birçok çizim seçenek yoktu.