Anyway, Ithink using plain text files and Word documents is way better than PDF files-for documentation/development guidelines. Also Iwill be able to use the SF site-as I have an account over there.
Printable View
Anyway, Ithink using plain text files and Word documents is way better than PDF files-for documentation/development guidelines. Also Iwill be able to use the SF site-as I have an account over there.
Same here. I agree... It's just that PDF files were quicker at the time I made mine.
I love the SourceForge description. I will start on the standards doc tomorrow. It will be basicly like the Microsoft suggestion naming conventions for VB.Quote:
Originally posted by techgnome
Sunofa #()$%&*!@#)($*%&!@#_)%$)!!!
I had a bunch of stuff typed in and then ....oh well, never mind.....
Take Two:
Ok, all caught up now. Happy New Year All! Now back to busuness.
blindlizard, you asked about SorceForge. Imagine Source Safe on steroids built for the web. It allows people from just about anywhere to work collaboratively on a project. It's built upon the Open Source License foundations. It would allow us to easily work on bits a pieces, keep track of to do lists, mail users/developers, etc.
Sounds like this will done using VB6, not a problem. I agree that the first thing that needs to be done is somekind of standards (for coding as well as UI design). I don't recommend using PDF for any files, ASCII Text or Word Doc should be used.... that way changes can be made as we need to.
As for me, I don't really have a whole lot of time and what time I do have, I tend to dedicate to my family. That said, here's what I am more that willing to do. Reviews, coordinations, testing, documentation, UI design (I've been told I kick arse at this - <shrug>). I also have 7month old who can also help with testing.
For any one interested, here's the info I submitted to SourceForge -- It will take another day or two to find out if it was approved or not.
Include indentation. I love indented code - it's much easier to read. Indenting with Tab key. I haven't read the MS suggested naming conventions, but if it doesn't include indenting, add it! :D
Also, I think we need a somple painting priogram for KidOS? Anyway, any good login screen forms for kidos yet? And I agree with the code should be indenred-makes it much eaiser to read/understand.
I disagree, I think it should not be indented, infact, let's just put it all on one line..... :D j/k -- couldn't resist.Quote:
Originally posted by aafuss
Also, I think we need a somple painting priogram for KidOS? Anyway, any good login screen forms for kidos yet? And I agree with the code should be indenred-makes it much eaiser to read/understand.
Good news all! The SourceForge account has been approved.
http://sourceforge.net/projects/kidos/
If you don't already have an SF account, please create one now, those who do have an account, click on the "[View Members]" link on the right hand side under Developers. Then click on the "email .... " link under my name. Let me know your SF account name and I will get you added to the developer list.
Ok, I signed up for a new account. How long before I get it activated? No email from them yet.
Ok, it finally came. Gnome my username is blindlizard. Thanks for setting this up.
OK I'm going to sign up. You'll recognize me.
My username is Osnr. Aafuss has a leftover account from his failed project.
No problem. You're set up.Quote:
Originally posted by blindlizard
Ok, it finally came. Gnome my username is blindlizard. Thanks for setting this up.
Osnr, you're added too.Quote:
Originally posted by Osnr
My username is Osnr. Aafuss has a leftover account from his failed project.
I started writing up naming / coding conventions, but I have decided just to use Microsoft's. It is much easier. Here is a link to MSDN. http://msdn.microsoft.com/library/de...nsoverview.asp
There are 3 links that define the conventions (Object Naming, Constant and Variable Naming, and Structured Coding).
I do want to amend somthing, when making an SQL query, do not define the string variable to hold it as QRY. Stick with the normal string declaration i.e. strSQL = "SELECT soemthing FROM something".
If I find other things I don't agree with , I will let everyone know.
Osnr I thought you were Aafuss's friend. You slam him A LOT!Quote:
Originally posted by Osnr
My username is Osnr. Aafuss has a leftover account from his failed project.
I'd like to go one step further and suggest that we avoid Databases all together..... distributing MDAC can be a real pill.....Quote:
Originally posted by blindlizard
I started writing up naming / coding conventions, but I have decided just to use Microsoft's. It is much easier. Here is a link to MSDN. http://msdn.microsoft.com/library/de...nsoverview.asp
There are 3 links that define the conventions (Object Naming, Constant and Variable Naming, and Structured Coding).
I do want to amend somthing, when making an SQL query, do not define the string variable to hold it as QRY. Stick with the normal string declaration i.e. strSQL = "SELECT soemthing FROM something".
If I find other things I don't agree with , I will let everyone know.
:)
I disagree with one naming convention:
Instead of "mstrString" or "glngLong" let's add in an underscore, for readability, so they become "m_strString" and "g_lngLong".
Also it does say to indent code.
Yeah let's avoid the database - plain delimited text files and/or the registry are fine.
Boy I take a day off to recover from New Year's Eve and I miss a ton.
I'm finally caught up. This looks great!
cbond, when you get a SF account set up, let me know & I'll add you to the list of developers.Quote:
Originally posted by cbond
Boy I take a day off to recover from New Year's Eve and I miss a ton.
I'm finally caught up. This looks great!
We need *more* developers. Anyone want to post in the Project Requests forum?
Good call.... done:
http://www.vbforums.com/showthread.p...hreadid=222999
I'll also post in a few other places, and on my site too.
Ok, I guess we don't need databases for this. I just want that in there incase we do :)Quote:
Originally posted by techgnome
I'd like to go one step further and suggest that we avoid Databases all together..... distributing MDAC can be a real pill.....
I thought that same thing when I read it. It doesn't really matter to me. Lets take a vote, what does everyone else think?Quote:
Originally posted by Osnr
:)
I disagree with one naming convention:
Instead of "mstrString" or "glngLong" let's add in an underscore, for readability, so they become "m_strString" and "g_lngLong".
Also it does say to indent code.
Yeah let's avoid the database - plain delimited text files and/or the registry are fine.
*** Oh, more ammendents to the Conventions. ***
In the Structured Conventions, add a line to the procedure header that is Author: with your full name, SF/VBForums username, and email.
Also, add a line Date: with the date you created the procedure.
Then if you edit someones code, add a line that says Edited By: and the same info as author, and a line that is Edited Date: with the date you made the changes. Finally a line that is Chages: explainations of what changed.
Example
VB Code:
'**************************************************** ' Purpose: Locates the first occurrence of a ' specified user in the UserList array. ' Inputs: ' strUserList(): the list of users to be searched. ' strTargetUser: the name of the user to search for. ' Returns: The index of the first occurrence of the ' rsTargetUser in the rasUserList array. ' If target user is not found, return -1. 'Author: SomeName, SomeSFAccount, SomeVBForumsAccount, SomeEmail 'Date: 12/31/2002 'Edited By: SomeOtherName, OtherSF, OtherVBF, OtherEmail 'Edited Date: 1/1/2003 'Changes: Whatever I did goes here '****************************************************
Since this will be open source, may I suggest that you use the your SF email addr..... or not include the email at all, since it can be easily derrived from the SF user name (SF_UserName@sourceforge.net)Quote:
Originally posted by blindlizard
*** Oh, more ammendents to the Conventions. ***
In the Structured Conventions, add a line to the procedure header that is Author: with your full name, SF/VBForums username, and email.
Also, add a line Date: with the date you created the procedure.
Then if you edit someones code, add a line that says Edited By: and the same info as author, and a line that is Edited Date: with the date you made the changes. Finally a line that is Chages: explainations of what changed.
Example
VB Code:
'**************************************************** ' Purpose: Locates the first occurrence of a ' specified user in the UserList array. ' Inputs: ' strUserList(): the list of users to be searched. ' strTargetUser: the name of the user to search for. ' Returns: The index of the first occurrence of the ' rsTargetUser in the rasUserList array. ' If target user is not found, return -1. 'Author: SomeName, SomeSFAccount, SomeVBForumsAccount, SomeEmail 'Date: 12/31/2002 'Edited By: SomeOtherName, OtherSF, OtherVBF, OtherEmail 'Edited Date: 1/1/2003 'Changes: Whatever I did goes here '****************************************************
Sounds good. Just user SF email not SF user and not regular email. But do add your VBForums user name.Quote:
Originally posted by techgnome
Since this will be open source, may I suggest that you use the your SF email addr..... or not include the email at all, since it can be easily derrived from the SF user name (SF_UserName@sourceforge.net)
VB Code:
'**************************************************** ' Purpose: Locates the first occurrence of a ' specified user in the UserList array. ' Inputs: ' strUserList(): the list of users to be searched. ' strTargetUser: the name of the user to search for. ' Returns: The index of the first occurrence of the ' rsTargetUser in the rasUserList array. ' If target user is not found, return -1. 'Author: SomeName, SomeSFEmail, SomeVBForumsAccount 'Date: 12/31/2002 'Edited By: SomeOtherName, OtherSF, OtherVBF, OtherEmail 'Edited Date: 1/1/2003 'Changes: Whatever I did goes here '****************************************************
Wow, bold comments... Looks weird.Quote:
Originally posted by techgnome
Since this will be open source, may I suggest that you use the your SF email addr..... or not include the email at all, since it can be easily derrived from the SF user name (SF_UserName@sourceforge.net)
Another thing I didn't notice in the conventions. This one is obvious, but I want it said none the less.
We are going to use Hungarian Notation when creating Variables and Procedure names. All that means is that each word in the name start with a capital letter. i.e. strDatabaseConnection. capital D and Captial C. Connstants however are all uppercase and word seperated by underscore (_) i.e strDATABASE_CONNECTION
I disagree with naming conventions for constants. What if you have to change a constant's data type? Then you have to replace all instances of the constant's name. Just use uppercase and underscores for contants.
Well if you have to chage data types then you will probably have to chagne your code any way. If I am using a constant integer to pass to an API and someone changes it to a string, my code will blow up. But if they change it to a string and change the name to strCONSTANT and my code is intCONSTANT then Option Explicit will pick it up before it compiles.Quote:
Originally posted by Osnr
I disagree with naming conventions for constants. What if you have to change a constant's data type? Then you have to replace all instances of the constant's name. Just use uppercase and underscores for contants.
I agree with Osnr on constants. They should just be capped. No prefixing.
CONNECTION_STRING
Let's consider this an unofficial vote. What about you, aafuss?
I prefer prefixing even on constants. I just think it makes the code more readable and more clear.Quote:
Originally posted by Osnr
Let's consider this an unofficial vote. What about you, aafuss?
my official unofficial vote: Won't matter to me. My personal pref is to not prefix constants (makes them easier to find). But since I don't plan to do much coding, it's really up to you guys.
I think prefixing on constants makes the code unreadable and unclear.
Well, we're tied 2-2. I'm just waiting for aafuss's vote.
How can explaining the data type make it unclear?Quote:
Originally posted by Osnr
I think prefixing on constants makes the code unreadable and unclear.
W/o the data typing it makes it painfully clear that it is a constant.Quote:
Originally posted by blindlizard
How can explaining the data type make it unclear?
Tell ya what..... everyone create a quick doc on what they would like to see as the standards. Email them to me at [email protected], I'll condence them and repost it back to everyone for comment. The sooner we can get through this, the sooner we can get going. But, at the same time, we need to make sure we set a solid foundation.
Or you can tell me where to go & how to get there (I won;t mind, I get it all day long).
I think everything but the constants declaration has been agreed on. I imagine that constants will be used mainly for APIs, so with that in mind, if you write an API function either use or don't use the prefix. I doubt anyone else will be using your constants
I agree.