რა არის HTML კომენტარები და როგორ გამოიყენება ისინი
aWhen თქვენ იხილოთ ვებ ბრაუზერი, ხედავთ ვიზუალური წარმომადგენლობა რა რომ ნაჭერი პროგრამული უზრუნველყოფა (ვებ ბრაუზერი) არის ნაჩვენები საფუძველზე კოდი კონკრეტული ვებგვერდზე. თუ თქვენ იხილავთ ამ კოდის ვებ-გვერდს, ნახავთ სხვადასხვა HTML ელემენტების, მათ შორის პარაგრაფების, სათაურების, სიების, ბმულების, სურათების და სხვა დოკუმენტების შედგენილ დოკუმენტს. ყველა ამ ელემენტს ბრაუზერის მიერ სტუმრის ეკრანზე გამოხატავს ვებ-გვერდის ჩვენება. ერთი რამ შეგიძლიათ იპოვოთ HTML კოდი, რომელიც არ არის გაცემული პიროვნების ეკრანზე არის ის, რაც ცნობილია როგორც "HTML კომენტარები".
რა არის კომენტარი?
კომენტარი არის HTML- ის, XML- ის ან CSS- ის კოდის სიმები, რომელიც არ არის ნანახი ან მოქმედებდა ბრაუზერის ან პარსორის მიერ. უბრალოდ დაწერილია კოდს, რომ კოდის დეველოპერებისგან კოდის ან სხვა გამოხმაურების შესახებ ინფორმაცია მიაწოდოს.
უმეტეს პროგრამულ ენებზე კომენტარები აქვთ, ისინი ხშირად იყენებენ კოდის დეველოპერს ერთი ან ერთზე მეტისთვის, შემდეგი მიზეზით:
- აღწერეთ და ახსენით რთული კოდი, ვისაც მომავალში ესაჭიროება მუშაობა - მათ შორის თავად! ისინი შეიძლება დაბრუნდნენ კოდით 3 ან 6 12 თვის ან უფრო მოგვიანებით და არ მახსოვს, რატომ გააკეთეს რაღაც გარკვეული გზა. კომენტარებს შეუძლიათ კითხვებზე პასუხების გაცემა და შეახსენოთ, თუ სად იყო მათი განზრახვა, როდესაც ისინი ამ გვერდის თავდაპირველად შეიმუშავეს.
- დეტალების წარმოდგენა, როდესაც კოდი იყო რედაქტირებული ან გადამოწმებული. ეს შეიძლება იყოს სასარგებლო ინფორმაცია და მოქმედებდეს გარკვეულწილად, როგორც საიტის ბოლო დროს მუშაობის განვითარების ჟურნალი.
- წაშალეთ კოდის მონაკვეთები, მაგრამ დატოვეთ ისინი მოგვიანებით. ეს ხშირად ხდება საიტზე ტესტირებისა და გამართვის დროს. თუ თქვენ გაქვთ პრობლემა საიტზე და არ ხართ დარწმუნებული, თუ რა იწვევს მას, კომენტარს შეგიძლიათ განუწყვეტლივ განვიხილოთ განყოფილებების ერთ-ერთ მომენტში და გამოვსახოთ საკითხი და შემდეგ გაეკეთებინათ პრობლემის მოგვარება, რაც თქვენ გაქვთ.
- ესაუბრეთ კოდზე მომუშავე სხვა დეველოპერებს. ეს სავარაუდოდ გაკეთდება განვითარების პროცესში ისე, რომ დეტალურად გაეცნოს კოდორზე მომუშავე სხვებს. თუ ეს კომენტარები მხოლოდ განვითარებული საუბრებია, ეს არის საუკეთესო პრაქტიკა, რომ ამოიღონ ისინი კოდიდან დაწყებამდე.
ტრადიციულად, HTML- ში შეტანილი კომენტარები თითქმის ნებისმიერი ელემენტისთვის გამოიყენება, კომპლექსური მაგიდის სტრუქტურების ახსნა-განმარტებებით, გვერდის შინაარსის ინფორმაციული შენიშვნებისთვის. მას შემდეგ, რაც კომენტარებს არ უშვებენ ბრაუზერში, შეგიძლიათ დაამატოთ ისინი სადმე HTML- ში და არ იდარდებთ იმას, რაც ამას გააკეთებს, როდესაც საიტი მომხმარებელს იხილავს.
როგორ დავწეროთ კომენტარი
HTML, XHTML და XML- ში კომენტარების წერა ძალიან მარტივია. მარტივად რომ გესაჭიროებოდეს ტექსტი, გაითვალისწინეთ შემდეგი:
და ->როგორც ხედავთ, ეს კომენტარები იწყება "სიმბოლოზე ნაკლებზე", ასევე სასიამოვნო წერტილისა და ორი დაბრკოლება. კომენტარი მთავრდება ორი შემობრუნებით და "უფრო დიდია, ვიდრე სიმბოლო: იმ სიმბოლოებს შორის, თქვენ შეგიძლიათ დაწეროთ ის, რაც თქვენ გინდათ რომ გააკეთოთ კომენტარი.
CSS- ში, ცოტა განსხვავებულია, C კოდირების კომენტარების ნაცვლად, ვიდრე HTML თქვენ დაიწყებთ წინ სლაშს, რასაც მოჰყვება ვარსკვლავი. თქვენ შეწყვეტთ კომენტარს ტერფის შებრუნებასთან ერთად, ვარსკვლავით მოჰყევით წინსვლას.
/ * კომენტარი გააკეთა ტექსტის * /კომენტარები მკვდარი ხელოვნებაა
ყველაზე პროგრამისტებმა იციან სასარგებლო კომენტარები . კომბინირებული კოდი უფრო ადვილად იძლევა ამ კოდს ერთი გუნდიდან მეორეზე გადასასვლელად. კომენტარები დაგეხმარებათ QA- ს გუნდში, რათა შეამოწმოთ კოდი, რადგან მათ შეუძლიათ თქვან, თუ რას ითხოვს დეველოპერი - თუნდაც ის მიღწეული არ არის. სამწუხაროდ, ვებ-გვერდის ავტორიტეტული პლატფორმების პოპულარობა, როგორიცაა WordPress, რომელიც საშუალებას მოგცემთ მიიღოთ და გაატაროთ შერჩეული თემა, რომელიც ბევრად უფრო სწორად ხორციელდება HTML- ისთვის, კომენტარებს ხშირად არ იყენებს ვებ-გვერდები. ეს იმიტომ ხდება, რომ კომენტარი ძალიან რთულია, რომ ნახოთ უმეტესი ვიზუალური სავარჯიშო ინსტრუმენტების შემთხვევაში, თუ თქვენ არ მუშაობს უშუალოდ კოდით. მაგალითად, ვიდრე ხედავს, ზედა ვებ გვერდზე:
ვიზუალური ინსტრუმენტი გვიჩვენებს პატარა ხატი, მიუთითოს, რომ კომენტარი არსებობს. თუ დიზაინერი ფიზიკურად არ გახსნის კომენტარს, ის შეიძლება არასდროს დაინახოს. და ამ გვერდის შემთხვევაში, შეიძლება გამოიწვიოს პრობლემები, თუ იგი რედაქტირებს გვერდზე და რომ რედაქტირება ზედმეტად წერილობითი მიერ წერილობითი კომენტარი.
რა შეიძლება გაკეთდეს?
- დაწერეთ მნიშვნელოვანი და სასარგებლო კომენტარები. არ ველით სხვა ადამიანს, რომ წაიკითხოთ თქვენი კომენტარი, თუ ისინი ძალიან გრძელია ან არ შეიცავს სასარგებლო ინფორმაციას.
- როგორც დეველოპერი, თქვენ ყოველთვის უნდა განიხილოთ ნებისმიერი კომენტარი, რომელსაც ხედავთ გვერდზე.
- გამოიყენეთ ავტორიზებული პროგრამების საშუალებები, რომლებიც საშუალებას გაძლევთ დაამატოთ კომენტარი.
- გამოიყენეთ შინაარსის მართვის კონტროლი, თუ როგორ რედაქტირებულია გვერდები.
მაშინაც კი, თუ თქვენ ხართ ერთადერთი ადამიანი, რომელიც რედაქტირებს თქვენს ვებ-გვერდებზე, კომენტარებს შეიძლება სასარგებლო იყოს. თუ წელიწადში ერთხელ მხოლოდ გართულებული გვერდის რედაქტირება ადვილია, დაიმახსოვრე, თუ როგორ ააშენეთ მაგიდა ან შევიტანოთ CSS. კომენტარებით, თქვენ არ უნდა გვახსოვდეს, როგორც ეს არის დაწერილი უფლება თქვენთვის.
ჯენიფერ კრიინინის ორიგინალური სტატია. რედაქტირებულია Jeremy Girard on 5/5/17