Re: Standard Euphoria Library project
D. Newhall wrote:
> Juergen Luethje wrote:
>>
>> I'm sorry for the delay in replying. I was a little distracted.
>>
>> I'll have a look at it. I'll also again have look at Tommy's Kanarie, to
>> see how good it might be suited for this task.
>>
>> So what do we need to start:
>>
>> o Some pages on the web.
>> - Christian's site, my site, SourceForge?
>
> Totally agree. I think we need to get a website up with information and
> contact info so people know what's going on, what we need, and how to
> contribute.
>
>> o There we'll write down
>> - A mission statement
>> - Coding guidelines
>
> As for coding guidelines, this could be a bit problematic... We
> certainly need them but everyone has their own idea of what is "right".
> I'd suggest keeping the guidlines as close to Rob's code as possible.
I'd also prefer that.
> While many people might like the "aVal is an atom, cVal is a constant,
> etc." style I think keeping the libraries as close to "standard" as
> can be is a good idea and so far all we really have is Rob's code.
>
> Here is what some of these guidelines would be:
Huuu.. that's already rather specific stuff. For me very fine in general
-- especially since my private coding habits are very similar 
.
Too strict for anyone?
> Constant names are all written in all capital letters.
> ex. constant TRUE = 1
> Global variables start with a capital letter.
> (NOTE: Not Rob's coding style but many people do this and I think it
> works very well)
> (ALSO NOTE: global could mean global in the file or global as in
> exported)
> ex. integer Debug_switch
> Local variables are written in all lowercase letters.
> ex. integer index
> All routines and types are written in all lowercase letters.
> ex. function get()
> Varaible names are written in a "block" style.
> ex. constant A = "A",
> BC = "bc",
> DEF = "def"
> Comments should have at least one space after the "--",
... and IMHO before the "--", too.
> if there isn't one it's commented out code
IMHO we should mark commented out code more clearly. Maybe with ++ or
something at the beginning, so that it can easily be found using the
search function of an editor, and with a short note why it was commented
out?
> ex. -- This is a comment, below is a line of code commented out
> --line = "commented out"
> All code blocks whould be indented with 4 spaces like ed does.
> ex. if x = 5 then
> do_crap()
> end if
> If the next line is run off from a previous use 2 space indent.
> ex. If a = 5 and b = 4
> and c = 3 then
> For the most part, constants and routines should not be abbreviations.
> (Only local variables)
> ex. integer pos
> procedure position()
>
>> - A list of say 3 to 5 .e files that should be contained in the first
>> release.
>
> string.e -- String handling
> cgi.e -- CGI routines
> math.e -- Math functions
> system.e -- File system commands (move_file(), delete_file(), etc.)
>
> I also have a list of routines that should be written for each.
>
>> - A list of contributers (Who will do what?)
>
> I'll gladly contribute code (I have tons of libraries for my own use)
> and I'm sure other people will once the ball gets rolling.
That's what I think, too.
>> I don't have any experience with organizing such a project.
... but I think for instance Christian has from the OpenEu project.
However, he currently seems to be busy or isn't online or ...
For my personal feeling time had come to collect all the good ideas that
have been posted here recently, and to write them down in order (more or
less). So you'll now find two files concerning the Euphoria Standard Library
on my website
- http://home.arcor.de/luethje/esl/index.htm
- http://home.arcor.de/luethje/esl/esl_paper01.htm
I hope this is OK for everyone. The files can stay on my website, or we
can put them anywhere else -- it doesn't matter for me. We just should
not have more than one place, where the documents are.
The "papers" are only drafts which will have to be revised, of course.
Regards,
Juergen
|
Not Categorized, Please Help
|
|
