វិចារណ៍ HTML
វិចារណ៍ HTML (HTML Comments) គឺជាកូដដែលមិនត្រូវបានបង្ហាញជាលទ្ធផលនៅលើគេហទំព័រ ប៉ុន្តែនៅតែមានក្នុងកូដប្រភព HTML ។ វិចារណ៍ប្រៀបដូចជាក្រដាសចំណាំដែលអ្នកកត់ត្រាទុកសម្រាប់ខ្លួនឯង ឬអ្នកអភិវឌ្ឍន៍ផ្សេងទៀតដើម្បីយល់ពីកូដ ។
គោលបំណងប្រើប្រាស់
- ពន្យល់កូដ៖ ប្រាប់ថា កន្លែងនោះនិយាយអំពីអ្វី និងហេតុអ្វីបានសរសេរកូដនោះ
- រៀបចំកូដ៖ ចែកផ្នែកធំៗនៃកូដឲ្យងាយអាននិងរក្សា
- បិទកូដបណ្តោះអាសន្ន៖ ធ្វើឲ្យកូដមួយចំនួនមិនដំណើរការដោយមិនចាំបាច់លុប
- កត់ត្រាកិច្ចការ៖ បង្ហាញអំពីអ្វីដែលត្រូវសរសេរបន្តទៀត ឬកែប្រែ
- សហការក្នុងក្រុម៖ ជួយអ្នកអភិវឌ្ឍន៍ផ្សេងយល់ពីកូដរបស់អ្នក
- ការ debug៖ សាកល្បងកូដដោយបិទបើកផ្នែកផ្សេងៗ
រចនាសម្ព័ន្ធ
វិចារណ៍ HTML ត្រូវបានប្រកាសដោយប្រើប្រាស់រចនាសម្ព័ន្ធពិសេស៖
- ចាប់ផ្តើម៖ សរសេរ
<!--(សញ្ញាតូច + សញ្ញាឧទាន + សហសញ្ញាដកពីរ) - មាតិកាវិចារណ៍៖ សរសេរអត្ថបទឬការពន្យល់របស់អ្នក
- បិទ៖ សរសេរ
-->(សហសញ្ញាដកពីរ + សញ្ញាធំ)
សំខាន់៖ វិចារណ៍មិនអាចមានវិចារណ៍ខាងក្នុងវិចារណ៍បានទេ (nested comments) ។
ឧទាហរណ៍មូលដ្ឋាន
ឧទាហរណ៍ងាយៗនៃការប្រើវិចារណ៍ក្នុង HTML៖
វិចារណ៍ច្រើនបន្ទាត់
វិចារណ៍អាចមានច្រើនបន្ទាត់សម្រាប់ការពន្យល់លម្អិត៖
វិចារណ៍សម្រាប់បិទកូដបណ្តោះអាសន្ន
នេះជាមុខងារដ៏មានប្រយោជន៍ខ្លាំងក្នុងការ debug និងសាកល្បង៖
វិចារណ៍សម្រាប់ចែកផ្នែកកូដ
វិចារណ៍ជួយឲ្យកូដមានការរៀបចំល្អនិងងាយអាន៖
ប្រភេទវិចារណ៍ក្នុងគម្រោងទំនើប
អ្នកអភិវឌ្ឍន៍ជំនាញប្រើវិចារណ៍ដែលមានគំរូពិសេសដើម្បីឲ្យងាយស្រួលស្វែងរក៖
ជំនួយការរៀន៖ ឧបករណ៍អភិវឌ្ឍន៍ទំនើបអាចរកឃើញវិចារណ៍ទាំងនេះដោយស្វ័យប្រវត្តិ និងបង្ហាញជាបញ្ជីកិច្ចការ ។
វិចារណ៍សម្រាប់ការ debug
ប្រើវិចារណ៍ដើម្បីបិទបើកផ្នែកផ្សេងៗនៃកូដក្នុងពេល debug៖
កំហុសដែលត្រូវជៀសវាង
នេះជាកំហុសធម្មតាដែលអ្នកត្រូវជៀសវាងនៅពេលប្រើវិចារណ៍៖
១. ភ្លេចបិទវិចារណ៍
២. ដាក់វិចារណ៍ខាងក្នុងវិចារណ៍
៣. ដាក់ព័ត៌មានសម្ងាត់ក្នុងវិចារណ៍
ការអនុវត្តល្អបំផុត (Best Practices)
- សរសេរឲ្យច្បាស់លាស់៖ វិចារណ៍ត្រូវខ្លី និងងាយយល់
- ពន្យល់ "ហេតុអ្វី" មិនមែន "អ្វី"៖ កូដប្រាប់អ្វីដែលវាធ្វើ វិចារណ៍ត្រូវពន្យល់ហេតុផល
- ធ្វើបច្ចុប្បន្នភាព៖ លុប ឬកែវិចារណ៍ចាស់ដែលមិនត្រឹមត្រូវទៀត
- ប្រើសម្រាប់ចែកផ្នែក៖ ប្រើវិចារណ៍ដើម្បីបែងចែកផ្នែកធំៗនៃកូដ
- កុំដាក់ព័ត៌មានសម្ងាត់៖ អ្នកប្រើប្រាស់អាចមើលឃើញវិចារណ៍ក្នុងកូដប្រភព
- លុបកូដចាស់៖ កុំទុកកូដចាស់ជាវិចារណ៍ - ប្រើ Git ជំនួស
សរុប
- វិចារណ៍ HTML ចាប់ផ្តើមដោយ
<!--និងបិទដោយ--> - វិចារណ៍មិនបង្ហាញនៅលើគេហទំព័រ ប៉ុន្តែមានក្នុងកូដប្រភព
- ប្រើវិចារណ៍ដើម្បីពន្យល់កូដ រៀបចំកូដ និង debug
- មិនអាចដាក់វិចារណ៍ខាងក្នុងវិចារណ៍បានទេ
- កុំដាក់ព័ត៌មានសម្ងាត់ក្នុងវិចារណ៍