Posted By

engel on 11/28/07


Tagged

bug change optimize programming notes todo fixme changed improve


Versions (?)

Who likes this?

1 person have marked this snippet as a favorite

zingo


Programming Notes


 / Published in: PHP
 

Here are some commonly-used notes given in PHP sources, especially in multi-developer projects. They are used to note various things, such as things to improve and bugs at that line.

  1. <?php
  2.  
  3. // TODO: Enter some task that needs to be done.
  4. // FIXME: Enter some bug that needs to be fixed.
  5. // FIXME(BugNumber): Reference a bug number for FIXME.
  6. // CHANGED: Once finished with TODO, replacement with CHANGED is recommended.
  7. // NOTE: Enter a simple note.
  8. // OPTIMIZE: A TODO specifically for optimization notes.
  9. // IMPROVE: A TODO specifically for improvement notes.
  10.  
  11. // Examples:
  12.  
  13. // TODO: Add in a update script.
  14. // FIXME: Bug in update script (cannot download new file).
  15. // FIXME(81239): Bug in update script (cannot download new file).
  16. // CHANGED: Added update script.
  17. // NOTE: The update script is still a bit buggy.
  18. // OPTIMIZE: Update download speed.
  19. // IMPROVE: Make the UI a bit better for update script.
  20.  
  21. ?>

Report this snippet  

You need to login to post a comment.