Emacs: C-U (79) # a pretty 79 character length divider VIM: 79-i-# see above Textmate: ???? Or is it just assumed that we'll make a Ruby call or have a snippet somewhere? ...
I am just checking out F#, so apologies if this is a silly question, but in the VS2008 F# CTP 1.9.6.2 'Tutorial' project, both // and /// are used for commenting code. Is there a functional difference between the two slash vs three slash commenting, or is it convention (as it appears in the tutorial code) to comment a function with /// ...
Over the years as I have gone through school and been working in the industry I have often asked people for advice on commenting. Sadly, as we all know, commenting with many developers is something that is taken as a side note and not much else. With that said I usually get a fairly general answer. Really this does not help much to se...
I want to add the ability to submit, moderate and display comments on an existing set of websites. Surely there's already a bunch of open source components that can handle the following: Comment submission Markup validation Private comment moderation Threaded comment display Locally installed (so works seamlessly with my existing regi...
I've never used a documentation system before, typically using commenting by hand but I think it would be nice to do so for a new project. What do you guys/gals advise? I've heard of Sandcastle but not sure if that's the best out. (This is for an open-source project so it needs to be free unfortunately.) ...
Where can I find a Visual Studio plug-in that automatically generates documentation header for methods and properties? Example the comment to a property could look like this: /// <summary> /// Gets or sets the value of message /// </summary> public static string Message { get { return message; } set { ...
Is there a good way to document ExtJS classes and functions and display them in html similar to the ExtJS documentation itself? I've looked into JSdoc but this doesn't seem to work with ExtJS. Are there any other tools that can do this? ...
Duplicate What are your hard rules about commenting? A Developer I work with had some things to say about commenting that were interesting to me (see below). What is your personal approach/take on commenting? "I don't add comments to code unless its a simple heading or there's a platform-bug or a necessary work-around ...
What special techniques you use when modifying existing code? Eg: Say you modify a business rule inside a method. Do you mark the modified section with special comments? Any coding/commenting standards you use when modifying code? ...
When you read a "howto"-style article with a code sample, which do you prefer: All the code off to the side with very few comments, and a complete line-by-line breakdown in the article OR All the code off to the side with LOTS of comments, and a complete line-by-line breakdown in the article The moral of my question: Can too many...
I am on a large project, and have not really made any comment 'headers' in my program yet. I just started using SVN for the project the other day. I want to add the SVN tag $id$, but have not decided on any standard commenting. So, my question to everyone here, is how does your initial comment block look in all your programs? i.e: /...
is there any open-source and extendable tool like what js-kit/disqus provides that could be self hosted ? ...
I want to open-source my notes similarly as at DjangoBook. I have not found any similar open-source system as at the website. I am particularly interested in the vertical commenting system. This suggests me that I need to build one by myself for open-source. How would you build a similar commenting system as at the website? ...
What does this mean? /** * ... * @author ... */ and now do i use it? thanks! (tried google-ing first, but wildcards are throwing it off) ...
Do you write comments in 2nd or 3rd person? // go somewhere and do something (2nd person comment) or // goes somewhere and does something (3rd person comment) ...
It happens more often than not that I have to comment several lines at once in vim. Methods that I know are not as fast as say TextMate way to comment lines out. What is your favorite way to do it? I currently use Method 1: - go to first char of a line and use blockwise visual mode (CTRL-V) - go down/up until first char of all li...
Hi I have like 50 pages of code that I should write comments to it ... Can you guys show me the best way. I meant I need you to write me a sample ... the comments should contain nearly everything (classes, constructors, attribute, methods, events, functions) ...
my python code is interlaced with lots of function calls used for (debugging|profiling|tracing etc.) for example: import logging logging.root.setLevel(logging.DEBUG) logging.debug('hello') j = 0 for i in range(10): j += i logging.debug('i %d j %d' % (i,j)) print(j) logging.debug('bye') i want to #define these resource consumi...
I just saw some code in bash that I didn't quite understand. Being the newbie bash scripter, I'm not sure what's going on. echo ${0##/*} echo ${0} I don't really see a difference in output in these two commands (prints the script name). Is that # just a comment? and what's with the /*. If it is a comment, how come it doesn't int...
Hi, I am writing a C++ static library and I have been commenting with doxygen comments in the implementation files. I have never really had to care very much about documentation but I am working on something now that needs to be documented well for the users and also I am trying to replace my previous bad habit of just wanting to code a...