:: urbansheep (urbansheep) wrote,
:: urbansheep

  • Music:

[ L ] Successful Strategies for Commenting Code


Commenting your code is like cleaning your bathroom—you never want to do it, but it really does create a more pleasant experience for you and your guests. Because I’ve recently adopted a new mantra to use comments frequently and appropriately in my code, I spent a few hours researching the literature on commenting readability, reusability, and guidelines.


Хороший обзор разных практик и одновременно — набор рекомендаций о том, как удобнее документировать исходный код комментариями. Типы комментариев, оформление, обобщение, с примерами и полезной дискуссией в комментариях к самой записи. Понравилось простотой.

Интересно было узнать, кстати, что достаточно много людей сначала расписывает алгоритмы в комментариях, а не только одна я такайа тупайа умница, которая без вербализации просто не понимает, что делать.


  • Post a new comment


    Comments allowed for friends only

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded