Yazardan: yorumlama, uygulaması kolay özelliklerden biridir. Aynı zamanda, bu düzenleme öğeleri, kodu elden ele geçiren geliştiricilere büyük fayda sağlayabilir. Bugün PhpStorm'da bir bloğu nasıl yorumlayacağınızı öğreneceksiniz. Programın içeriğini yorumlamak için geri kalan geliştirme ortamı işlevselliğini de dikkate alacağız.

Yorumlar: iyi ve kötü

Kod yorumlama çoğu programlama dilinde mevcuttur (muhtemelen hepsinde, ancak değişen derecelerde kullanılabilirlik ile). Tipik olarak, sözlü açıklamalar diğer ekip üyelerinin daha fazla gelişmesine yardımcı olmak için veya sadece bu alanın düzeltilmesi gerektiğini kendimize hatırlatmak için kullanılır (“BENİ DÜZELT”).

Yazılanların izahı elbette bir lütuftur. Ancak yorumların yardımıyla kodun tüm iyi yönlerini de aşabilirsiniz. Bunun olmasını önlemek için yorum türlerini ayırt etmek gerekir:

belgelemek. İyi bir birliktelik, çeşitli amaçlar için dokümantasyon kavramı olacaktır. yazılım... Bu tür yorumlar, kodu bir talimat gibi kullanmanıza yardımcı olur. Bu tür yorumlar gereksiz olarak algılanmaz, çünkü onsuz hiçbir şey yoktur. Birinin bir geliştirme çerçevesi kullandığını ve size programı nasıl kullanacağınızı söylemediğini hayal edin;

JavaScript. Hızlı başlangıç

açıklayan. İyi kod genellikle onlara ihtiyaç duymaz. Bir programda ne kadar çok yorum satırı görürseniz, programın kötü yazılmış olma olasılığı o kadar artar. Elbette bu mutlak bir kural değildir.

Açıklayıcı yorumlar ileride kodu düzeltecek olanlar için faydalı olabilir. Örneğin, birçok genç profesyonel, her yerde iyileştirme alanı görüyor. Kendilerinden önce her şeyin daha kötü olduğuna inanıyorlar ve şimdi her bir özelliği düzeltmenin zamanı geldi.

Bazen benzer bir duygu profesyonelleri bunaltıyor. Örneğin, her şey şaşırtıcı bir şekilde çarpık göründüğünde, daha iyi bir çözüm olmalı. Takipçileri en iyiyi aramaktan kurtarmak için programcı şöyle bir not bırakabilir: # time_spent_here = 24h

Bu tür sözlerden sonra, çok az insan bu kadar çok zaman geçirmek ister. Böylece, setin farklı seçeneklerçoktan geçtiler. Aynı zamanda şu tür saldırılardan da kaçınmalısınız: #i_hate_this, # try_to_do_better_ass %% le. Bu şekilde sadece profesyonel olmayan bir tavır sergilemiş olursunuz. Kendinizden ve işvereninizden ödün vermeyin.

Ancak kodun belgesel yorumu, programcı için bir balast haline gelebilir. Kural olarak, bunlar doğrudan programlamadan dikkati dağıtan büyük bölümlerdir. Ancak kodu yorumsuz görüntülemek için ana IDE'lerin karşılık gelen bir işlevi vardır. PhpStorm bir istisna olmamalı, ama ne yazık ki. Güncelleme belgelerinde özelliği arayın.

İşlevsel bir öğe olarak etiketleyin

Yorum yapmak, takım gelişimine bir açıklama ve yardım olarak düşünülmüş olsa da, bu özellikler çok sık kullanılmamaktadır. Kural olarak, etiketler kodun yürütülmesini durdurmak istedikleri yere yerleştirilir. Diyelim ki HTML'ye gömülü PHP'niz var. Ve onu silmek istemiyorsunuz, sadece sayfanın onsuz nasıl göründüğünü görmek istiyorsunuz. Bunu yapmak için aşağıdaki sözdizimini izlemelisiniz:

JavaScript

…

…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div >

Gördüğünüz gibi basit eylemlerle, karmaşık işlemler bile gerçekleştirmeden kodun yürütülmesini durdurabilirsiniz. Ama aslında, bu henüz optimizasyonun zirvesi değil. Geliştirici için ek kolaylık, phpStorm IDE'nin kendisi tarafından sağlanır. Vurgulama ve klavye kısayollarını kullanarak, özel etiketler eklemeden seçilen kod segmentini yorumlayabilirsiniz. Bu şöyle yapılabilir.

Sizin için uygun bir yöntem kullanarak bir metin parçası seçin (fare, kısayollar).

Ctr + Shift + / klavye kısayoluna basın

Ayrıca mevcut satıra yorum yapabilirsiniz. Her şey aynı, sadece Shift olmadan.

Bu tür yorumların avantajı, birkaç dili aynı anda kapsamasıdır. PHP nadiren kendi başınadır. Bu şekilde, her birini etiketlemek zorunda kalmazsınız. Ortam birkaç web dilini daha destekler. Sadece bir parça seçin ve kombinasyonu satın - bu çok dilli koddur ve yorumlanmıştır. Aynı şekilde aktif hale getirilebilir.

Bizim için bu kadar. Bu özellikleri daha önce kullanmadıysanız, başlamanızı öneririz. Kısaltmalar işi daha hızlı ve daha iyi hale getirir.

JavaScript. Hızlı başlangıç

Web uygulaması oluşturmaya yönelik uygulamalı bir örnekle JavaScript temellerini öğrenin

... bugün bu kısa ama faydalı yazıda, farklı program kodlarının nasıl yorumlandığını anlayacağız. Fazla bir şey söylemeyeceğim, çünkü bununla ilgileniyorsanız, o zaman zaten bu problemin sorularıyla karşı karşıya kaldınız ve bunun hakkında bir fikriniz var.

Adrese geldiniz ... ancak netlik ve davanın yararı için birkaç kelime. Muhtemelen bunun CSS koduyla nasıl yapıldığını görmüşsünüzdür, çünkü css benim gibi birçok yeni başlayanın ilgisini çekiyor.

… İyi!

Ancak, yorumların şu durumlarda da kullanıldığını unutmayın. html ve php... Ancak yeni başlayanların çoğu, site ile çalışmalarının ilk aşamasında kafaları karışır ve kendileri için gerekli açıklamaları nasıl ekleyeceğini bilemez. Sonuçta, olur, örneğin, bir süre devre dışı bırakmanız gerekir. HTML Kodu, ve sonra tekrar işlevine devam edin - "kenar boşluklarında" kendiniz için notlar aldıysanız, uygulaması kolaydır, ancak ne olduğunu asla bilemezsiniz.

Ancak genel olarak "yorumlar" hakkında hatırlanması gereken şey - buradaki her şey, özellikle hangi dosyayla çalıştığınıza bağlıdır ve bu nedenle uygulama kodu farklıdır.

CSS kodunu yorumlama

a: üzerine gelin, a: odak (renk: # D5071E; metin dekorasyonu: Üst çizgi; / * ALT ÇİZGİ YUKARI * /)

Kendinizi bu şekilde açıklıyorsunuz. Veya bu css betiğini tamamen şu şekilde yorumlayabilirsiniz: sadece sarın

/ * KOD burada * /

/ * a: üzerine gelin, a: odak (renk: # D5071E; metin-dekorasyon: alt çizgi; / * ALT ÇİZGİ * /) * /

Dikkatinizi şu gerçeğe çekiyorum - css kodunun tüm döngüsünü bu şekilde yorumlayabilirsiniz, ancak !! o zaman tekrarlanan yorumları / * ALT ÇİZGİYİ * / kaldırmanız veya açıklama önemliyse eğik çizgi ile oynamanız gerekir))

Aksi takdirde bir hata olacaktır !!

Not:

eğer açarsan kaynak sayfa - Ctrl + U ve bir göz atın ... yorumlanan css kodunun oluşturulan belgede güzel bir şekilde görüntülendiğini göreceğiz! bu, doğrudan html'de css kullanılmışsa (özellikler ayarlanmışsa)

Ve bildiğiniz gibi, aktif şablonunuzun css belgesine atıfta bulunarak kaynak kodundan giderseniz - birinin ihtiyacı varsa tüm yorumlar gözlemlenebilir ve incelenebilir))). Ama bu pek olası değil)

İngilizce zarf (kelimeler) okunabilir olacaktır. Rus sembolizmi - hayır.

HTML kodunu yorumlama

XML dosyası aynı şekilde yorumlanır.

Önemli: Her zaman makalelerde verilen kodu en azından görsel olarak kontrol edin) aksi halde hatalar olabilir.

Biçimlendirmedeki olağan dikkatsizlik zaman alıcı olabilir, örneğin, yukarıda gösterilen COMMENTED kodu genellikle hatalıdır: iki kısa tire yerine bir uzun tire görünür:

Bilginize:

önceki açıklamada belirtildiği gibi - yorum da öyle ... oluşturulan belgede html kodu görüntüleniyor!

Bunu aklında tut.

Ve işte başka bir şey:

Yorumlanan kodun sayfanın kaynak kodunda görüntülenmesine ek olarak (bu, bir anlamda işlendiği anlamına gelir, ancak sayfada da görünmez olacaktır!) - birlikte bazı php işlevlerini kaldırmak daha iyidir. etkin belgeden html ile.

Örneğin:

belgede ve işlevde görünecekişini harika bir şekilde yapacak: yani, bilgi ön uçta görünmeyecek, kaynakta görünecek - net bir şekilde görüntülenecek! ve bu, veritabanına özel bir istek: tüm bunlar önemsiz, ama bilmeniz gerekiyor!

Belgeden bir kod parçası çıkarmak istemiyorsanız bunu yapmak mümkündür:

açılıştan önce gerekli "ekstra" html kodunu ekleyin... satır içi işlev ... ve kapatılıyor mu?> ...

Tek kelimeyle, kod büyükse bunu şu şekilde yapabilirsiniz:

**/ ?>

o zaman kaynak temiz olacak!

Veya daha basit:

Fonksiyonun kendisini yorumlayalım html belgesi... Bu durumlarda kaynak kodu, işlevlerin geliştirilmesi açısından temiz olacaktır!

JavaScript nasıl yorumlanır

if (Gösteriliyor || gösteriliyor) (// animasyonu tekrar tetikleme geri dön;) else (// satırda HERHANGİ BİR YORUM uygula // satırda HERHANGİ BİR YORUM uygula // true;

Netlik için, noktalama işaretlerini biraz ayarlayarak netten bu örnek JavaScript kodunu aldım. Önemli değil ... Asıl mesele, prensibi anlamaktır ...

Anladığınız gibi, eğik çizgi "//" çifttir, bu yorumun İŞARET'idir ... TEK SATIR!

JS kodunun geri kalanı php gibi yorumlanmıştır, daha fazlası aşağıdadır:

açıklama:

PHP kodunu yorumlama

... ve ... burada aynı - eğik çizgi ... tek satır.

Ancak, tıpkı CSS kodu gibi açıklama eklenebileceğini unutmayın.

... ya da yorum yapabilirsiniz - yorum satırından önce İKİ eğik DEĞİL, BECAR (karma) kullandığımızda tek satırlık bir seçenek:

... Doğal olarak, kod döngüsünde dikkatli bir şekilde yorum yapmanız gerekiyor!

... veya aynı şekilde - CSS için yukarıdaki örneğe benzer ... yani. bu / * kod * / yorum seçeneği hem CSS hem de JS kodları için çalışacaktır!

Ancak bu şekilde, ana örnekleri arasında bir yerde PHP koduna daha hacimli bir açıklama yapabilirsiniz ...

Ayrıca, eğer kod karıştırılmışsa, bunun gibi php döngülerinde yorum yapabilirsiniz ... php ve bir şekilde html

Yukarıdakine benzer:

Örneğin, bir tür işlev ... genel kodun bir yerinde (veya html'de bir döngü):- yorum yapabilirsiniz, yani kendi etiketinizi şöyle ekleyebilirsiniz:

ya da öylesine: tek satırlık bir seçenek ...

Zeka:

php kodu hiçbir kaynak kodunda görünmüyor !! sadece işlevsel sonucu görünür - çalışıyor!

Genel olarak, bugün bildirmek istediğim tek şey bu!

Şimdi deney yapabilirsiniz ... İyi şanslar.

Ve elbette sitenin makalelerini okuyun ve abone olun:
Acı deneyimimi paylaşıyorum - tatlı iyiliğiniz için biraz bilgi))

... web yöneticileri şehri Mikhalika.ru© - WordPress ile Kolayca

Bu derste, bunun nasıl yapılacağı hakkında konuşacağım. HTML, CSS, PHP'de yorumlar... Yorumlar, web sayfasında görünmeyen metinlerdir. Belgeyi yapılandırmanıza izin veren web yöneticileri için her türlü açıklama, hatırlatıcı, açıklama için kullanılırlar. Kod hatalarını ayıklarken yorumlar vazgeçilmezdir, bir web sayfasının işaretlemesinde hızlı bir şekilde gezinmenize ve ihtiyacınız olan bloğu bulmanıza olanak tanır. Çoğu zaman, yorumlar HTML kodunda hata ayıklamak için kullanılır. Örneğin, çalışmaması için belirli bir kod bloğunu geçici olarak yorumlayabilirsiniz ve gerekirse kolayca geri yüklenebilir.

HTML yorumları

HTML'de yorumlar semboller kullanılarak oluşturulur:... Bu nedenle, bu semboller arasındaki herhangi bir metin bir yorumdur. Bir örnek düşünelim:

Örnek HTML Yorumları

CSS'deki yorumlar

CSS yorumları / * ve * / sembolleri kullanılarak oluşturulur. Yorum oluşturmak için web sayfası kodunu şu sembollerin arasına yerleştirmeniz yeterlidir:

/ * Body * / body için stilleri olan bir bloğun başlangıcı (arka plan: #efeded; yazı tipi ailesi: Verdana, Helvetica, sans-serif; yazı tipi boyutu: 12 piksel; kenar boşluğu: 0 piksel; dolgu: 0 piksel;) / * Son Gövde * / için stilleri olan bir blok

PHP Yorumları

PHP yorumları tek satırlı veya çok satırlı olabilir:

1) PHP'de tek satırlık yorumlar şu semboller kullanılarak oluşturulur: //. Bu sembolü satırın önüne koymanız yeterlidir ve yorum yapılacaktır.Bu seçenek, yorumun sadece bir satırdan oluştuğu durumlarda kullanılır.

2) Çok satırlı yorumları uygulamak için şu semboller kullanılır: / * ve * /. Bu seçenek, yorum birden çok satıra yayılıyorsa kullanışlıdır.

Böylece yapmayı öğrendik

25.04.2017

Herkese merhaba!
çalışmaya devam ediyoruz PHP temelleri sıfırdan!
Bu derste sizlere PHP'de yorumun ne olduğunu anlatacağım ve pratikte koda yorumumuzu yazmaya çalışacağız. Ama hepsi bu değil. Ayrıca size kodu nasıl yorumlayacağınızı ve neden yapılması gerektiğini anlatmak istiyorum.

yorum nedirPHP
Yorum yapPHP- bu, kodda hızlı gezinme ve düzenlemeler için bir php geliştiricisinin ipucudur.

PHP'deki yorum, web sayfasını görüntülemek için açan kullanıcı tarafından görülmez. Kullanıcı sayfanın kaynak koduna bakmaya karar verse bile, tüm php.ini dosyasından bu yana yorum yine görünmeyecektir.

PHP kod yorumu

PHP kodu için 2 tür yorum vardır:

→ bir satır
→ çok satırlı

⇒ PHP için tek satırlık yorum
Tek satırlık bir yorum için "//" veya "#" sembollerini kullanın.

Bu karakterlerden sonra bir satıra yazılan her şey yok sayılacak ve yorum olarak kabul edilecektir.

Güncellemeye abone olun "; # abonelik (bu bir yorumdur)?>

Güncellemek için abone olun

⇒ PHP için çok satırlı yorum
PHP için çok satırlı bir yorum "/ *" ile başlar ve "* /" ile biter.
Bu karakterler arasındaki herhangi bir şey yok sayılır ve yorum olarak kabul edilir.
Kayıtta birden çok satır varsa, çok satırlı bir yorum kullanılır.

Ekranda yalnızca aşağıdaki metni göreceksiniz:

Merhaba blog okuyucuları - site !!!

Not: Her zaman kodunuzu yorumlayın. 1-2 yıl içinde kodda yaptığınız her şeyi hatırlayacağınızı düşünüyorsanız yanılıyorsunuz, şans çok az. Hatırlasanız bile neyi, nerede ve neden çalışmak için çok zaman harcamanız gerekecek...
Gelecekte kendiniz için hoş bir şey yapın - kodu yorumlayın ve ardından kendinize “TEŞEKKÜRLER !!!” diyeceksiniz.
Kodda bir yorum bırakın, 1 dakika sürecek, ancak gelecekte size tam bir gün kazandıracak.

PHP kodunu yorumlayın

Diyelim ki php kodu yazdınız ama nedense koddan 2 satırı çıkarmanız gerekiyor.
Koddan bir şey çıkarmak için acelem yok, özellikle de php koduysa, yorum yapmayı tercih ederim. Ya kodu iade etmeniz gerekiyorsa. Yorumu kaldırmak, kodu yeni bir şekilde yazmaktan daha kolaydır.

İçindeki kod nasıl yorumlanırPHP
Tek satırlık yorum içeren örnek:

Güncellemeye abone olun ";?>

Çok satırlı yorum içeren bir örnek.