Finance          Automotive          Computers          Health          Shopping          Sports         News          Reference           Print Facts in English - BCUZ.COMlos hechos en Español

Comment (computer programming)



One example of this variability of comment types is the use of audio files to include voice annotations in source code.[28]

[

See also

  • Comment (computing) for a general discussion on the use of comments in computing.
  • Docstring, a specific type of comment that is parsed and retained throughout the runtime of the program

[

Notes and references

  1. ^ Some programming environments include comments as one element of the language syntax that is retained for further processing, instead of discarded once recognized by the language processor.
  2. ^ Comments must be indicated in a way that allows a source code processor to recognize them as such. This is often simplified by saying comments are "ignored" (after they have been recognized and discarded) by the processor.
  3. ^ Comments can be processed in various ways to generate documentation external to the source code itself. See e.g., Comparison of documentation generators.
  4. ^ Penny Grubb, Armstrong Takang (2003). Software Maintenance: Concepts and Practice. World Scientific. ISBN 981238426X. 
  5. ^ Dixit, J.B. (2003). Computer Fundamentals and Programming in C. Laxmi Publications. ISBN 8170088828. 
  6. ^ Higham, Desmond (2005). MATLAB Guide. SIAM. ISBN 0898715784. 
  7. ^ Vermeulen, Al (2000). The Elements of Java Style. Cambridge University Press. ISBN 0521777682. 
  8. ^ a b c Using the right comment in Java. Retrieved on 2007-07-24.
  9. ^ W. R., Dietrich (2003). Applied Pattern Recognition: Algorithms and Implementation in C++. Springer. 3528355581.  offers viewpoints on proper use of comments in source code. p. 66.
  10. ^ a b Keyes, Jessica (2003). Software Engineering Handbook. CRC Press. 0849314798.  discusses comments and the "Science of Documentation" p. 256.
  11. ^ a b The Elements of Programming Style, Kernighan & Plauger
  12. ^ a b Code Complete, McConnell
  13. ^ Spinellis, Diomidis (2003). Code reading: The Open Source Perspective. Addison-Wesley. ISBN 0201799405. 
  14. ^ CodePlotter 1.6 - Add and edit diagrams in your code with this 'Visio-like' tool. Retrieved on 2007-07-24.
  15. ^ a b Niederst, Jennifer (2006). Web Design in a Nutshell: A Desktop Quick Reference. O'Reilly. ISBN 0596009879. Sometimes the difference between a "comment" and other syntax elements of a programming or markup language entails subtle nuances. Niederst indicates one such situation by stating: "Unfortunately, XML software thinks of comments as unimportant information and may simply remove the comments from a document before processing it. To avoid this problem, use an XML CDATA section instead."
  16. ^ Ambler, Scott (2004). The Object Primer: Agile Model-Driven Development with UML 2.0. Cambridge University Press. ISBN 1397805218. 
  17. ^ Arensburger, Andrew (2001-03-27). /* You Are Expected to Understand This */ (editorial). freshmeat.net.
  18. ^ Worst Practice - Bad Comments. Retrieved on 2007-07-24.
  19. ^ Morelli, Ralph (2006). Java, Java, Java: object-oriented problem solving. Prentice Hall College. ISBN 0131474340. 
  20. ^ a b How to Write Doc Comments for the Javadoc Tool. Retrieved on 2007-07-24. JavaDoc guidelines specify that comments are crucial to the platform. Additionally, the appropriate level of detail is fairly well-defined: "We spend time and effort focused on specifying boundary conditions, argument ranges and corner cases rather than defining common programming terms, writing conceptual overviews, and including examples for developers."
  21. ^ Dewhurst, Stephen C (2002). C++ Gotchas: Avoiding Common Problems in Coding and Design. Addison-Wesley Professional. ISBN 0321125185. 
  22. ^ Doar, Matthew B. (2005). Practical Development Environments. O'Reilly. ISBN 0596007965. 
  23. ^ (see e.g., http://www.vidarholen.net/contents/wordcount/ Linux Swear Count, http://www.google.com/codesearch?hl=en&lr=&q=fucking Google Code Search).
  24. ^ Andress, Mandy (2003). Surviving Security: How to Integrate People, Process, and Technology. CRC Press. ISBN 0849320429. 
  25. ^ Coding Style. Retrieved on 2007-07-24.
  26. ^ Allen Holub. Retrieved on 2007-07-24.
  27. ^ Allen Holub, Enough Rope to Shoot Yourself in the Foot, ISBN 0-07-029689-8, 1995, McGraw-Hill
  28. ^ http://dev.devbiz.com/blogs/hakan/archive/2005/08/03/voice_comments.aspx Voice Comments

[

External links




BCUZ.com FACTS Encyclopedia content is licensed under the GFDL as approved by Wikipedia.
For more information review our copyright contact and privacy policy.
© 1996 - BCUZ.COM - We have all the FACTS you need about Small Business Financing, Behavior Disorder, Having Too Many Bills, Needing Cash Fast, Structured Settlements, Frequent Flier Programs, Top Steak Houses, The Mayan Indians, Norfolk and Suffolk England, Growing Longer Hair and a full reference English Encyclopedia and Spanish Encyclopedia.Privacy Policy