Select the search type
  • Site
  • Web
Search
You are here:  Support/Forums
Support

Bring2mind Forums

Comments On Comments
Last Post 05/31/2010 3:06 PM by Peter Donker. 1 Replies.
Sort:
PrevPrev NextNext
You are not authorized to post a reply.
Author Messages
bw@mk
New Member
New Member
Posts:3


--
05/28/2010 5:00 PM

Something that would be extremely helpful with the partial source is some type of documentation on the API or at the very least comments in the code.  I am guilty of not commenting my code as well, but if I am planning on others, especially customers who purchased the source code, reading my code then I would certainly do so.  It seems that whenever someone brings up this point, the answer is that this forum is the documentation, but I really don't think that a handful of posts and responses satisfies the requirement for documentation.  The extensions to the module we were planning are going to take much longer to implement because of the amount of time we must spend analyzing the source and trying to determine how things work.   

Peter Donker
Veteran Member
Veteran Member
Posts:4536


--
05/31/2010 3:06 PM
Hi Brandon,

Point taken. I have tried to make method and variable names as intuitive as possible but this is no substitute for proper API documentation. It is on the todo list but not something that's going to be complete soon. I'll do my best in helping anyone develop extensions here and work on the documentation moving forward.

Peter
You are not authorized to post a reply.