guidelines

Project Wiki items

If you would have to standardize wikis for software development projects, how would you structure them? Such a wiki template, I think could contain items such as... Welcome to the project Coding Guidelines Team directory ... What other items in your experience would be critical to be included in a project wiki? ...

Good limits for code refactoring

What are your preferred limits for, Lines per file Lines per function Nesting Are there other effective guidelines for limiting / settings (i.e. large font size)? FYI, I code mostly in Python along with some C,Java,Ruby etc. Edit: The reason I'm not asking about number of char columns is because 80 columns generally is the hard lim...

Too many constants?

Is there such a thing as too many constants in a project? What are some general rules of thumb about where the use of constants starts to become inappropriate and should be refactored? Perhaps moving some of these values into a model tier, or configuration files, etc. A concrete example. Using the pureMVC framework for Actionscript/Flex...

How to code for Alternate Course AKA Rainy Day Scenary?

Alternate course is something when user doesn't do what you expected, e.g. key in wrong password, pressing back button, or database error. For any programming project, alternate course accounts for more than 50% of a project timeline. It is important. However, most computer books only focus on Basic Course (when everything goes fine). ...

Guidelines for using jQuery plugins and their dependencies

jQuery plugins often have dependencies on extrnal files: jQuery library, style sheets (CSS), images, other plugins, etc. What are the guidelines for using (and writing) jQuery plugins that would address the placement of the dependencies? In the other words, where should the required files go: under main app folders (Img, Css, JS, or what...

making a windows forms validation library for own use

I wish to make controls like textbox, combobox, listbox and other user editable controls to be bound with validation, so i thought of extending the existing controls and make a new VTextBox, VComboBox, VListBox which have a validationregex property and an error provider component attached with them. My prime aim is to have validation att...

Is there a standard or guideline for creating XML files?

I’m curious if there is standard or guideline for determining what types of things should be attributes vs elements within the xml file. I’m also curious about creating xmlarray and xmlarrayitem lists using XMLSerializer. For example if I have the following: <SomeBaseTag> <Item1 Attr11=”one” Attr12=”two” /> <Item1 Attr11=”one” A...

In Multiple inheritance, which class should be listed first, My-App-Class or Language-Framework-Class

In Python, while designing a multiple inheritance subclass, should I place my app class first or language/framework/third-party class first? Based on your experience which do you recommend: 1) My app class before a native or third party class class MyClass(MyAppBaseClass, SomeLibraryOrNativePythonClass): or 2) A native or third p...

Official Java Code Guidelines/Conventions

Where can I find the most up-to-date official style conventions/guidelines (like how to properly name variables, methods, formatting, etc) for Java? ...

Outside access to Facebook events

Let's say I own/control a Facebook page where events are posted. I'd like to display these events on another website (In my case, a WordPress blog, but that's not the important part) on an "Upcoming events" page. What I'm unsure about is: Is the Facebook API usable "externally" like this? I've downloaded the PHP library and got a demo a...

How do you prevent your application from feature overloading

I'm a single shareware developer and many times i make the mistake of adding too many features into my application. For example different ways to filter and display informations. One of the reasons is that during programming i often see some ways that might be easy to implement and may give some benefit for the user. But often they tur...

General advice and guidelines on how to properly override object.GetHashCode()

According to MSDN, a hash function must have the following properties: If two objects compare as equal, the GetHashCode method for each object must return the same value. However, if two objects do not compare as equal, the GetHashCode methods for the two object do not have to return different values. The GetHashCode method for...

Fields for reseting password

I am upgrading my reset password procedure of my webpage. What fields should i include in my SQL table? After searching all over the web i decided to add these goodies Guid Expiration date of guid (i guess 3 days is fine) Timestamp of the change password request Ip address of the user is there anything else that could be usefull? ...

C#: How should ToString() be implemented?

The problems are: GUI libraries like to use ToString as a default representation for classes. There it needs to be localized. ToString is used for logging. There it should provide programming related information, is not translated and includes internal states like surrogate keys and enum values. ToString is used by many string operatio...

What suggested guidelines would you list for "when to use a web service?"

I'm working with an older set of developers who "enjoy" interop at the database level and I'm trying to put together a solid list of "guidelines" for my team so they know "when to use a web service" Other than "when you want 2+ systems to inter operate" - what would you list here? ...

Newsletters. Sending a web Page as mail body

I ve seen a lot of good and "bad" in implementation newsletters. In my opinion Devexpress has good ones. I never clicked the "Having trouble reading this newsletter in your E-Mail client?" because the message is allways displayed correctly. I have also seen "bad" newsletters. "Attachments, pictures, and links in this message have been ...

Guidelines for GUI design for a risk analysis app

In my free time, I'm working on a risk analysis application. I have already finished the mathematical and simulation engines, but I'm stuck with the design of the user interface. I want my application to be as easy-to-use as possible for Excel users, but I don't want to make it an Excel add-in, because Excel takes ages to load add-ins. S...

Is it acceptable to design a method with a parameter of type System.Enum?

Consider the following method, public void Add(Enum key, object value); Since Enum is a "special class", I didn't realize you could use the type in this way, but it compiles. Now, the .NET Framework Design Guidelines don't have anything to say about this construction, so I'm curious what everyone else thinks about this. Here is what...

COM interface declarations

Hi, When creating COM interface declarations in C# are there any "rules" you have to stick to? I think there are and would like to get some info on it. For example I'm toying around with the ITaskbarList, ITaskbarList2 and ITaskbarList3 interfaces and it seems to me that I Have to declare the order of the members in the manages implem...

Deployment and Maintainence guidelines and strategies for large scale web applications

I work on a small scale application (about 5000 users), but we do maintain some important user preference data. Whenever we release an upgrade we check if there are users online (we do it after hours and usually there are none) and then just put an outage page and apply the new build (both UI and DB changes). It all takes about half and ...