Son zamanlarda bazı akış şemaları yaptım ve aynı sorunla, alt rutin çağrıları nasıl sunabileceğimizi veya belki de bugünlerde onları adlandırabileceğiniz gibi yöntem ve işlev çağrılarını zorladım.
Alt rutin ÇAĞRILAR'ı alt rutin REFERANSLAR'dan ayırdığım konvansiyona karar verdim. Birincisi için, program yürütmedeki o noktada geçerli olan değişkenleri kullanarak, yapılan argümanlarla çağrıyı gösteren sıradan bir dikdörtgen kullanıyorum.
Çift taraflı "önceden tanımlanmış işlem" dikdörtgeni basitçe bu işlevin veya alt rutinin tanımını içeren başka bir akış şemasına başvuru olarak kullanıyorum. Alt rutin dikdörtgenin, alt rutinin argümanlarını göstermesi gerekmez, çünkü bu, söz konusu alt rutinin tanımlayıcı akış şemasının bir parçasıdır, ancak bunları zaten okuyabilmesi için referansa eklemek yararlı olabilir. çağrıda kullanılan gerçek argümanların anlamlarına bakınız.
Bu, dikdörtgen sayısını arttırır, ancak bu diğer akış şemalarının, çağrılan işlevlerin bazılarının tanımını aramak için var olduğunu daha açık hale getirir. Genellikle bir işlev basitse, bunun için ayrı bir diyagram oluşturmayacağım, sadece sözlü olarak belgeleyeceğim.
Ayrıca ayrıntıların kod listesinden bakılması gerektiğini söylemek için "belge" sembolünü kullanıyorum.
Bir akış şemasının amacı bir program yaratmak değil, başkalarının bir programı anlamasını kolaylaştırmaktır. Bence kuş bakışı bir yardım ve bu amaç akılda tutulmalıdır. Programınızın HER ayrıntısını görsel olarak tanımlamak için değildir, ayrıntılar gerektiğinde koddan görülebilir. Akış şeması, programınızın üst düzey bakış açısından yalnızca bir resmi.
Akış şemalarını yüksek seviyede tutmak, kod değiştirildikçe bunların güncel tutulmasına daha az ihtiyaç olduğu anlamına gelir.
Onlar resim. İyi bir hikaye gibi yazılım belgelerinde de koda alternatif bir bakış açısı veren resimler olmalıdır.