Programlama atölyesi sunumlarında kodu yönetmenin iyi yolu

Şu anda bir programlama atölyesi kuruyorum (aslında OOD ile ilgili, ancak bu çok da önemli olmamalı).

Esas olarak iki tür kaynağım var:

• slaytlar (HTML / reveal.js)
• örnek projeler (Java)

Birçok yerde, örnek projelerin kodları sunumda görünmelidir.

Bunu başarmanın iyi bir yolu nedir?

Gereksinimlerim

• sunumda kullanılacak bir kod pasajını ve bunun görünmesi gereken yeri belirtmenin kolay bir yolu

• Koddaki değişiklikler otomatik olarak sunuya yansıtılır (bir derleme aracı çalıştırmak tamamdır, el ile kesme ve yapıştırma işlemleri gerçekleştirilmez)

• kopmuş bağlantılar (var olmayan bir kod pasajını gömmeye çalışmak veya sunumda kullanılmayan bir pasajı işaretlemek gibi bir uyarı oluşturmalıdır)

• Kod ve sunum arasında bağlantı olduğu için bonus puan

Asciidoctor http://asciidoctor.org/ gereksinimlerinizin çoğunu çözebilir:

• içeriği yazmak için sade ASCII kullanın
• Gerçek kaynak kod dosyalarından gelen kod parçacıklarını içerir
• kesik linkler çıktıyı oluştururken bir uyarı yaratacak
• reveal.js ve deck.js'de sunumlar oluşturuldu

Https://github.com/asciidoctor/asciidoctor-gradle-examples adresinde Asciidoctor'un gradle ile nasıl kullanılacağına dair bazı örnekler bulacaksınız (ancak diğer derleme araçları da işe yarar).

Sen edebilirsiniz Burada örnek çıkışını göz ve deck.js ve reveal.js ile işlenen bir sunum bulacaksınız ( "Çıkışlar" etiketli alt bölümlerde 3.4 ve 9.4'lük arayın)

Diğer bir ilham kaynağı Dan Allan’ın desteleri olabilir: https://github.com/mojavelinux/decks

Ayrıca koddan sunuma geri dönüş bağlantıları istediniz. AFAIK'in size sağlayabileceği en iyi Asciidoctor, kod snippet'ini ( // tag::XXX[]) kodunda işaretlemek için kullandığınız etiketin de sunumunuzun kaynağında ( include::Class.java[tags=XXX]) bulunacağı anlamına gelir.