Ваш способ написать простые комментарии

Question

Как вы, ребята, пишете комментарии по некоему простому коду, который вы используете только для себя?

Я в основном пишу JavaScript и PHP-код, и я не могу чувствовать, что нашел хороший способ писать комментарии.

Если у меня есть короткая строка кода, я обычно делаю это:

x = doThis(getSomeValueFromSomewhere()); // This is a short line of code 

Что выглядит очень хорошо, я думаю, но это не на самом деле работает, когда линия становится немного больше или на нескольких линиях,

// Dont really like this since it's not clear if it describes only line 1, or all lines. 
aLongerVariableName = (getSomeValueFromSomewhere() == "this is what I want") ? "true value" : "false value"; 
x = doThis(aLongerVariableName); 

Итак, как вы это делаете?

Answer 1

(* 
* For blocks of comments that serve as important documentation 
* e.g descriptions of functions. 
*) 

может быть переформатирован в

(* For blocks of comments thet serve as important documentation 
    * e.g descriptions of functions. *) 

, // и для коротких встроенных комментариев, как вы делаете. Не забывайте, что Ctrl-/является вашим другом ;-)

Answer 2

Один простой способ улучшить блоки комментариев/разложения в javascript, который работает очень легко и быстро при программировании.

Если вы хотите, чтобы сделать блок комментария в JavaScript, что нужно добавить это хорошо известный способ:

/* 
... 
*/ 

Так что, когда вам нужно decomment вам нужно изменить начало/* и конец * /, но я так:

/* 
... 
//*/ 

Таким образом, изменяя начало/* до * // вы decomment весь блок, только addning один символ и без необходимости искать в конце комментария.