Відмінності між версіями «5 Коментарі»

Матеріал з Wiki TNEU
Перейти до: навігація, пошук
 
(3 проміжні версії 2 користувачів не показані)
Рядок 1: Рядок 1:
 
Коментарі - пояснення до початкового тексту програми, що знаходяться безпосередньо усередині коментованого коду. Синтаксис коментарів визначається мовою програмування. З точки зору компілятора або інтерпретатора, коментарі - частина тексту програми, що не впливає на її семантику. Коментарі не мають жодного впливу на результат компіляції програми або її інтерпретацію. Крім вихідних текстів програм, коментарі також застосовуються в мовах розмітки та мовах опису.
 
Коментарі - пояснення до початкового тексту програми, що знаходяться безпосередньо усередині коментованого коду. Синтаксис коментарів визначається мовою програмування. З точки зору компілятора або інтерпретатора, коментарі - частина тексту програми, що не впливає на її семантику. Коментарі не мають жодного впливу на результат компіляції програми або її інтерпретацію. Крім вихідних текстів програм, коментарі також застосовуються в мовах розмітки та мовах опису.
 +
Більшість фахівців сходяться на думці, що коментарі повинні пояснювати наміри програміста, а не код; те, що можна виразити мовою програмування, не повинно виноситися в коментарі. Зокрема необхідно розбивати програму на легкі для розуміння частини, прагнути до того, щоб структура класів і структура баз даних були максимально зрозумілими і прозорими. Є навіть думка (його дотримуються в екстремальному програмуванні та деяких інших гнучких методологіях програмування), що якщо для розуміння програми потрібні коментарі - значить, вона погано написана.
 +
Концепція грамотного програмування наполягає на включення в текст програми настільки докладних і продуманих коментарів, щоб вона стала вихідним текстом не тільки для виконуваного коду, але і для супровідної документації. Коментарі в PHP можуть бути як однорядкові так і багаторядкові. Однорядкові коментарі починаються із "//" або "#" (коментар скриптових мов UNIX). Багаторядкові коментарі починаються символами "/*" і закінчуються "*/" (без лапок). Слід зазначити, що однорядкові коментарі йдуть до кінця поточного рядка або завершального тега.
 +
Нижче наведений приклад скрипта із різними видами коментарів:
  
Більшість фахівців сходяться на думці, що коментарі повинні пояснювати наміри програміста, а не код; те, що можна виразити мовою програмування, не повинно виноситися в коментарі - зокрема, треба використовувати говорять назви змінних, функцій, класів, методів і пр., розбивати програму на легкі для розуміння частини, прагнути до того, щоб структура класів і структура баз даних були максимально зрозумілими і прозорими і т. д. Є навіть думка (його дотримуються в екстремальному програмуванні та деяких інших гнучких методологіях програмування), що якщо для розуміння програми потрібні коментарі - значить, вона погано написана.
+
<?php
 +
    echo "Це тест" ; // Це однорядковий коментар в стилі C++
 +
    /* Це багаторядковий коментар
 +
      ще один рядок коментарю */
 +
    echo "Це ще один тест" ;
 +
    echo "Останній тест" ;  #Це коментар в стилі оболонки Unix
 +
?>
  
Концепція грамотного програмування наполягає на включення в текст програми настільки докладних і продуманих коментарів, щоб вона стала вихідним текстом не тільки для виконуваного коду, але і для супровідної документації.
+
Не можна вкладати один в одний багаторядкові коментарі (вони можуть з’явитися під час коментування великих блоків). Наприклад:
Коментарі в PHP можуть бути як однорядкові так і багаторядкові. Однорядкові коментарі починаються із // або # (коментар скриптових мов UNIX). Багаторядкові коментарі починаються символами /* і закінчуються */ . Слід зазначити, що однорядкові коментарі йдуть або до кінця поточного рядка, або до завершального тега.
+
  
Коментарі в PHP скриптах
+
<?php
Написання практично будь-якого скрипта не обходиться без коментарів.
+
/*
PHP підтримує комметарі і в стилі 'C', 'C++' і оболонки Unix. Наприклад:
+
    echo "Це тест"; /* Цей коментар викличе проблему */
 +
*/
 +
?>
  
<?php
+
Однорядкові коментарі йдуть тільки до кінця рядка або поточного блоку PHP-коду, в залежності від того, що йде перед ними. Це означає, що HTML-код після "//?>" не буде сприйматись інтерпретатором PHP в якості закінчення коду, як це, можливо, очікувалось від "?>", тому що всі символи до кінця рядка, що йдуть після "//", вважаються коментарем.
    echo "Це тест" ;  // Це однорядковий коментар в стилі C++
+
    /* Це багаторядковий коментар
+
        ще один рядок коментарю */
+
    echo "Це ще один тест" ;
+
    echo "Останній тест" ;  #Це коментар в стилі оболонки Unix
+
?>
+
Однорядкові коментарі йдуть тільки до кінця рядка або поточного блоку PHP-коду, в залежності від того, що йде перед ними.
+
 
+
 
+
<h1> Це <?php # echo "простий"; ?> приклад. </h1>
+
<p> Тема вгорі виведе 'Це приклад".</p>
+
Будьте уважні, слідкуйте за відсутністю вкладених ‘C’-коментарів, вони можуть з’явитися під час коментування великих блоків:
+
 
+
<?php
+
  /*
+
    echo "Це тест"; /* Цей коментар викличе проблему */
+
  */
+
?>
+
Однорядкові коментарі йдуть тільки до кінця рядка або поточного блоку PHP-коду, в залежності від того, що йде перед ними. Це означає, що HTML-код після //?> не буде сприйматись інтерпретатором PHP в якості закінчення коду, як це, можливо, очікувалось від ?>, тому що // не дозволяє цього зробити.
+

Поточна версія на 01:01, 20 червня 2014

Коментарі - пояснення до початкового тексту програми, що знаходяться безпосередньо усередині коментованого коду. Синтаксис коментарів визначається мовою програмування. З точки зору компілятора або інтерпретатора, коментарі - частина тексту програми, що не впливає на її семантику. Коментарі не мають жодного впливу на результат компіляції програми або її інтерпретацію. Крім вихідних текстів програм, коментарі також застосовуються в мовах розмітки та мовах опису. Більшість фахівців сходяться на думці, що коментарі повинні пояснювати наміри програміста, а не код; те, що можна виразити мовою програмування, не повинно виноситися в коментарі. Зокрема необхідно розбивати програму на легкі для розуміння частини, прагнути до того, щоб структура класів і структура баз даних були максимально зрозумілими і прозорими. Є навіть думка (його дотримуються в екстремальному програмуванні та деяких інших гнучких методологіях програмування), що якщо для розуміння програми потрібні коментарі - значить, вона погано написана. Концепція грамотного програмування наполягає на включення в текст програми настільки докладних і продуманих коментарів, щоб вона стала вихідним текстом не тільки для виконуваного коду, але і для супровідної документації. Коментарі в PHP можуть бути як однорядкові так і багаторядкові. Однорядкові коментарі починаються із "//" або "#" (коментар скриптових мов UNIX). Багаторядкові коментарі починаються символами "/*" і закінчуються "*/" (без лапок). Слід зазначити, що однорядкові коментарі йдуть до кінця поточного рядка або завершального тега. Нижче наведений приклад скрипта із різними видами коментарів:

<?php
   echo "Це тест" ;  // Це однорядковий коментар в стилі C++
   /* Це багаторядковий коментар
      ще один рядок коментарю */
   echo "Це ще один тест" ;
   echo "Останній тест" ;  #Це коментар в стилі оболонки Unix
?>

Не можна вкладати один в одний багаторядкові коментарі (вони можуть з’явитися під час коментування великих блоків). Наприклад:

<?php
/*
   echo "Це тест"; /* Цей коментар викличе проблему */
*/
?>

Однорядкові коментарі йдуть тільки до кінця рядка або поточного блоку PHP-коду, в залежності від того, що йде перед ними. Це означає, що HTML-код після "//?>" не буде сприйматись інтерпретатором PHP в якості закінчення коду, як це, можливо, очікувалось від "?>", тому що всі символи до кінця рядка, що йдуть після "//", вважаються коментарем.

Особисті інструменти
Простори назв

Варіанти
Дії
Навігація
Інструменти