Başkalarının kaynak kodunu yorumlama [kapalı]

Not: Bu sorunun farkındayım . Bununla birlikte, bu soru biraz daha spesifik ve derinlemedir, ancak gerçek kodu ayıklamak veya yazara sormak yerine gerçek kodu okumaya odaklanır.

Giriş seviyesi bir bilgisayar bilimi dersinde öğrenci olarak arkadaşlarım ara sıra kendilerine ödevlerinde yardım etmemi ister. Programlama gurur duyduğum bir şey, bu yüzden her zaman mecbur kaldım. Ancak, genellikle kaynak kodlarını yorumlamakta zorlanıyorum.

Bazen bu garip veya tutarsız bir stile, bazen de ödevde belirtilen garip tasarım gereksinimlerine ve bazen de aptallığımdan kaynaklanıyor. Her halükarda, birkaç dakika boyunca ekrana bakan bir aptal gibi görünüyorum "Ah ..."

Genellikle sık karşılaşılan hataları kontrol ederim - çıkarıcı operatörler yerine virgül kullanarak noktalı virgül veya parantez eksik.

Sorun bu başarısız olduğunda gelir. Sıklıkla hata ayıklayıcıdan geçemiyorum çünkü bu bir sözdizimi hatası ve yazara sık sık soramıyorum çünkü kendisi tasarım kararlarını anlamıyor.

Genellikle başkalarının kaynak kodunu nasıl okursunuz? Kodu yukarıdan aşağıya doğru okuyor musunuz, yoksa her işlevi çağrıldığında mı takip ediyorsunuz? Ne zaman "Refactor zamanı" demenizi nereden biliyorsunuz?

İlk ipucu: sözdizimi hatalarını, yanlış yerleştirilmiş parantezleri ve diğer önemsiz hataları tespit etmek için bir IDE (veya çok iyi bir düzenleyici :)) kullanın.

İkinci adım: Tüm kodu rahat hissettiğiniz bir formatta otomatik olarak biçimlendirin. Bunun çok önemli değil ama şaşırtıcı olduğunu düşünürdünüz.

Yerel olarak adlandırılmamışlarsa yerel değişkenleri yeniden adlandırmaktan korkmayın. (Tam sisteme erişiminiz varsa, her şeyi yeniden adlandırabilirsiniz ve yapmanız gerekir.)

Belirli bir işlevin / yöntemin ne yaptığını keşfettiğinizde kendinize yorum ekleyin.

Sabırlı ol. Uzaylı kodunu anlamak kolay değildir, ancak yapbozun çoğu parçasının aniden yerine oturduğu her zaman bir atılım anı vardır. Bu noktaya kadar her şey çok sıkı çalışma ve angaryadan korkuyorum. İyi haber şu ki, uygulama ile bu eureka anı daha erken gelecek.

Sanırım bu konuda yanlış bir yaklaşım benimsiyorsunuz. Eğer insanlar kodları konusunda yardım için size dönüyorlarsa, sanırım geri dönme ve kodlarında size yol göstermeleri için onlara söyleme sorumluluğuna sahipsiniz. Hatalarını onlar için düzeltebilirsiniz ve bir şeyler öğrenebilirler (ezberleyerek), eğer kendi hatalarını (yardımlarınızla) tespit edebilirlerse daha fazla öğrenirler. Ayrıca, farklı insanların kodlamaya nasıl yaklaştığı konusunda daha geniş bir deneyim kazanacaksınız (bu da daha fazla kodu okumanıza / anlamanıza izin verecek) - erdemli bir döngü ...;)

Bu yeteneğin bir deneyim karışımı olması ve bunun için bir yeteneğe sahip olduğuna inanıyorum. Sıfırdan bir şeyler yapmalarını isteseydik az çok her şeyi çözebilecek çalışanlarımız vardı, aynı zamanda yazmadıkları kod parçalarında açıkça hatalar bulamıyorduk. Ve aynı zamanda, temel tasarımı aşan hiçbir şeye güvenmeyeceğimiz, ancak başkalarına dalmak ve sorunları kısa sürede takip edebilecek çalışanlarımız vardı.

Bununla birlikte, buna yaklaşmanın yolu kodu değiştirmektir. Alıştığınız şeye yeniden biçimlendirin, değişken adlarını sizin için anlamlı olan bir şeye değiştirin, kod net değilse yorum ekleyin. Senden yardım istediğinde, sorunu bulana kadar devam etmeli ve bir şeyler değiştirmelisin. Ardından, orijinal kodu düzeltmeyi veya kendinizinkini kullanmayı arkadaşınıza bırakın.

İlk olarak, sözdizimi hataları varsa, derleyici hatalarını dikkatlice okumalısınız. Genellikle bir satır hata olarak vurgulanır, ancak aslında hataya sahip olan önceki satırdı.

Bir giriş öğrencisi için, programın derlenmesini engelleyecek, görülemeyen bazı düzenleme yapıları olabileceğini unutmayın. Örneğin, bir keresinde dönüş yerine boşluk çubuğunu kullanan bir öğrenciyi (benim değil) gördüm: Kodu 80 sütundan sonra sarılmış bir editörde normal görünüyordu (öğrenci çok sabırlıydı) ve kod ekleyene kadar bile çalıştı //programın geri kalanını yorumlayan " " tarzı bir yorum. Benzer şekilde, kod örneklerini bir web sitesinden kopyalarsanız, genellikle kopyalanamayan karakterler de vardır (web sitesinin kodu nasıl biçimlendirdiğine bağlı olarak). Şüphe duyduğunuzda, kopyalayıp yapıştırmadan bir satıra yeniden yazın. [Bu biraz şaşırtıcı, ama son zamanlarda çok daha fazla olduğunu gördüm.]

Kötü derleyici hataları için, yeni bir dosya oluşturarak ve devam ederken tüm kodu yazarak programı büyütmeniz gerekebilir. Bir sonraki adıma geçmeden önce her büyük adımdan sonra derlediğinizden emin olun.

Peki, sözdizimi hatası yoksa ne olacak? Sonra kod adım adım! Bunun için bir hata ayıklayıcı kullanabilirsiniz, ancak printfkod boyunca çağrı yapmak da oldukça etkilidir. Örneğin, bir fordöngü varsa , döngü sayacı için bir print ifadesi ekleyin. İç içe fordöngüler olması durumunda , yanlış değişkenin artırıldığını görebilirsiniz.

printfS kullanmanın avantajı, şu anda baktığınız şeyi zaman / mekanda "sıkıştırma" yeteneğidir. Bir hata ayıklayıcı ile adım attığınızda, çok fazla alakasız durum görürsünüz ve daha sıkıcı olabilir. Ayrıca, konsola yazdırılanların geçmişini görmeden, bazı desenleri kaçırabilirsiniz. Buradaki nokta, hata ayıklayıcı ve printf'lerin tamamlayıcı teknikler olması ve her ikisinin de diğerinden daha iyi olmamasıdır.

Son olarak, arkadaşınıza neler olup bittiğini sorun! Ona bakmak ve "uh" demek yerine onlara ne yaptıklarını sorun: "şimdi ne yapıyor n?" Diyaloğu başlatarak, kendi sorularını cevaplayabilirler veya programın bir çözüme sahip olmalarını nasıl kavramsallaştırdıklarını fark edebilirsiniz, bu da sizi bir çözüme yönlendirebilir.

Başka bir yerde yorumlandığı gibi, tüm bu deneyim ile daha iyi olur. 20 yıldır programlama yapmama rağmen, son 5 yıla kadar öğrencilerle çalışmıyordum, hatalarında onlara daha iyi yardımcı oldum.

Bunu söylemekten nefret ediyorum, ama burada gümüş kurşun yok.

Açıkçası , vakaların% 10'unda bile yaptıklarını yazdıklarında başkalarının ne anlama geldiğini anlayabilecek kadar basiret olsaydım, şimdiye kadar milyonlarca şüphe gölgesi olmadan yapardım.

Daha pratik bir notta, akıllı bir IDE kullanmak adım 1'dir.

Adım 2 , kaynak kodu hiyerarşisini bulmak için doxygen veya benzeri bir şey çalıştırmak olacaktır .

Adım 3, bağlantı fonksiyonlarını veya nesneleri, komut satırınızı veya dosyanızı işleyen ve ardından mantık gerçekleştiren şeyleri bulmaktır.

Adım 3'e paralel olarak, kullanıyorsanız küreselleri takip edin. Ayrıca arkadaşlarınıza bilinen herhangi bir özel algoritma kullanıp kullanmadıklarını sorun - koda bakmadan önce algoritmayı okumak (eğer varsa) her zaman faydalıdır.

Tek kelimeyle: Deneyim, daha fazla deneyim kazandıkça, en iyi uygulamaları daha fazla öğrenir ve diğer insanların kodlarını yargılayabilir / anlayabilir. Otomatik olarak gelmez, bunun yerine genellikle aynı hatayı kendiniz yapmaktan gelir!

Bununla birlikte, programcıların kodlarını düzgün bir şekilde yorumlamayı öğrenmeleri önemlidir, çünkü koda baktığınızda genellikle koddan tahmin etmek çok zor olan büyük bir düşünce sürecinin sonucudur. Birkaç yorum, tasarım düşüncesi olan bir metin dosyası, kodu anlama ve tamamen yanlış anlama arasındaki farkı yaratabilir.

Aynı şeyi okuldaki laboratuvarda sık sık sordum. Genellikle, "Bu derleyici hatasını nasıl düzeltirim?" bu yüzden sarkanları else, eksik noktalı virgülleri ve benzerlerini tespit etmekte oldukça başarılı oldum . (Makrolar da hata ayıklamak için eğlencelidir - #define CUBE(x) x * x * xhepimizin yapmak istediği bir hatadır.) Sahip olduğum bir avantaj, aynı öğretmenlerle aynı sınıflardan geçmemdi, bu yüzden gereksinimleri zaten biliyordum.

En iyi çalıştığımı bulduğum işlem, çalışan bir iletişim kutusu tutmaktır. Programı onlar için yazmak istemezsiniz, çünkü öğrenmeleri gereken programlardır. Bu, onlarla aynı bilgisayarda olmanız gerektiği anlamına gelir. Laboratuarda bilgisayarlarına gelirdim. Derleyici mesajından başlayarak, hatayı tespit etmelerini sağlamaya çalışacağım. (C kullanıyorduk.) Satır numarasıyla başlayın ve mesajın ve hatanın nereye karşılık geldiğine dikkat edin. Aynı hatadan birden fazla varsa, onlara iki hata hakkında benzer olanları sorardım.

Bütün fikir diğer öğrenciye rehberlik etmektir. Kodlarını onlar için yeniden yazmak, öğrenmelerine yardımcı olmaz.

Sözdizimi hatalarını bulmak mantık hatalarından çok daha kolaydır. Sorunlarının çoğu sözdizimi ise, bir IDE bulun, kodlarını kopyalayıp yapıştırın ve hataları düzeltin. Mantık hataları çok daha zordur. Neden kodlarını açıklamalarını isteyemeyeceğinizi söylediğinizden emin değilim. Başka birine kod açıklayarak birçok mantık hatası buldum.