Comments on: Reviewer Notes: What we look for in Code Commenting and Help Documentation http://blog.activeden.net/resources/reviewer-notes-what-we-look-for-in-code-commenting-and-help-documentation/ The FlashDen Blog Sat, 28 Nov 2009 19:18:40 +0000 http://wordpress.org/?v=2.9.1 hourly 1 By: - Flash Spec - http://blog.activeden.net/resources/reviewer-notes-what-we-look-for-in-code-commenting-and-help-documentation/comment-page-1/#comment-2161 - Flash Spec - Fri, 27 Feb 2009 02:45:03 +0000 http://blog.flashden.net/?p=1163#comment-2161 JordanK, it's not about file rejection, it's about file usage. If there's no need in comment, you don't wright it. Whoever gets into your code, already knows to read it. Comments are required in non-self-explanatory and non-obvious situations. So, in your case, you'd better write a comment explaining what is "foo" JordanK, it’s not about file rejection, it’s about file usage. If there’s no need in comment, you don’t wright it. Whoever gets into your code, already knows to read it. Comments are required in non-self-explanatory and non-obvious situations.
So, in your case, you’d better write a comment explaining what is “foo”

]]> By: JordanK http://blog.activeden.net/resources/reviewer-notes-what-we-look-for-in-code-commenting-and-help-documentation/comment-page-1/#comment-2136 JordanK Tue, 24 Feb 2009 23:59:21 +0000 http://blog.flashden.net/?p=1163#comment-2136 On the note about comments and verbose comments, many people would see the following: //returns foo function getFoo():Foo{ return Foo; } as verbose because the function is self-explanatory and doesn't really require a comment. So does every function require a comment or just functions that aren't simple getter/setter functions? I'll probably just comment every function anyways to avoid the possibility of rejection but ideally I wouldn't bother writing such comments. On the note about comments and verbose comments, many people would see the following:

//returns foo
function getFoo():Foo{
return Foo;
}

as verbose because the function is self-explanatory and doesn’t really require a comment. So does every function require a comment or just functions that aren’t simple getter/setter functions? I’ll probably just comment every function anyways to avoid the possibility of rejection but ideally I wouldn’t bother writing such comments.

]]> By: Reaper-Media http://blog.activeden.net/resources/reviewer-notes-what-we-look-for-in-code-commenting-and-help-documentation/comment-page-1/#comment-2131 Reaper-Media Tue, 24 Feb 2009 18:10:54 +0000 http://blog.flashden.net/?p=1163#comment-2131 great tips, i had an item rejected once because of little AS comments, it only took 5 mins to update it :) great tips, i had an item rejected once because of little AS comments, it only took 5 mins to update it :)

]]> By: animike http://blog.activeden.net/resources/reviewer-notes-what-we-look-for-in-code-commenting-and-help-documentation/comment-page-1/#comment-2130 animike Tue, 24 Feb 2009 17:19:04 +0000 http://blog.flashden.net/?p=1163#comment-2130 It also helps when the purchaser actually reads your help files before they ask you questions. In my experience this happens 1 out of 10 times. :) It also helps when the purchaser actually reads your help files before they ask you questions. In my experience this happens 1 out of 10 times. :)

]]> By: SparkyFlash http://blog.activeden.net/resources/reviewer-notes-what-we-look-for-in-code-commenting-and-help-documentation/comment-page-1/#comment-2129 SparkyFlash Tue, 24 Feb 2009 12:46:37 +0000 http://blog.flashden.net/?p=1163#comment-2129 Great tips! Although I don't have many items for sale on FD, I always try to include as thorough documentation as possible. I think it really helps when a customer can find a necessary answer with step-by-step instructions and doesn't have to go online and ask the question in the item thread. Great tips! Although I don’t have many items for sale on FD, I always try to include as thorough documentation as possible. I think it really helps when a customer can find a necessary answer with step-by-step instructions and doesn’t have to go online and ask the question in the item thread.

]]> By: sike http://blog.activeden.net/resources/reviewer-notes-what-we-look-for-in-code-commenting-and-help-documentation/comment-page-1/#comment-2128 sike Tue, 24 Feb 2009 09:50:38 +0000 http://blog.flashden.net/?p=1163#comment-2128 Nice advice, maybe I need to remove some FAQ in the item description now. Nice advice, maybe I need to remove some FAQ in the item description now.

]]>