Home   Info   DevZone   Wiki   UsersWeb  |  MainWeb  |  InfoWeb  |  DevZoneWeb  |  SupportWeb
[ JosProgrammerFAQ ] [ not logged in ] [ Web: Imported ] goto:  options [ get info on or edit ] [ login or new user ] [ list of topics, hubs & nodes, or recent changes ]

FAQPages

What is the best way to program my applications to fit in with JOS and provide maximum code reuse?

We have all pretty much agreed to use the Model-View-Controller design pattern to keep our applications friendly for everyone in JOS. In addition, anything that is not specific to your application, and can be re-used by someone else, should be split off into one of the JOS library packages (like org.jos.lib), preferably as Beans whenever possible.

Additionally, supporting plugin Beans is a very good thing to do. An example would be a mail server that supports plugin Beans so people can easily change the behavior of the mailserver, without having to muck around in your code. Always think about making it easy on the user to upgrade/change the functionality in your program.

Here's an example of why this is A Good Thing: If you write an email client with a great GUI, I might want to come along and write some classes that use all of your code EXCEPT the GUI code. Instead, I want a commandline email client. If you used the Model-View-Controller design pattern, and kept "maximum code reuse" in mind, all I would need to do is create a different View/Controller for the program.

Check out the PatternsLinks page (http://www.jos.org/wiki/view/main/PatternsLinks) to find books on these patterns. "Design Patterns" is a popular book that discusses MVC and many other OO design patterns.

--MasonZhwiti (4/20/98)

What copyright or legal info belongs in my JOS-related code?

Needs an answer. I proposed a starting point on the JosCopyright page (which perhaps should have been named JosLicense).

Where is the best place to display my source code for comments?

First, post an announcement about your new code in NewSourceCode, and create a link to a page for your source code. On this new page you will need to provide a link to your source code. Upload your source code to the SourceServer. (Eventually we can probably stop using the NewSourceCode page, and just refer to the SourceServer...)

In that case (referencing the above answer), then what is the JOS CVS repository used for? How does it relate to the SourceServer?

[Your answer here.]

What coding style should I use for my JOS-related programming?

There are several CodingStyle's being debated, but quite a few people working on JOS (a majority?) feel that this is irrelevant since the SourceServer uses PrettyPrinter, a perl module that can reformat source code to fit different coding styles (defined on the fly).

That's nice, but I really meant: How should I name my variables? my methods? my classes? What package(s) do they belong in?

Oh, I see... well hopefully someone can come along and answer this question more definitively.

Try to program in a legible way, using human-sounding variable and class names. Provide comments and approaches used within the code, and try to JavaDoc your classes.

FAQ Changes (Newest to Oldest)

• Removed paragraph about Emacs which didn't really apply. Removed last question which seemed very redundant compared to one of the other questions about uploading source code. Added more definitive info on SourceServer. --MasonZhwiti (4/1/98 -- No fooling!)

Content of these pages are owned and copyrighted by the poster.
Hosted by: