Products

Solutions

Resources

Partners

Community

Blog

About

QA

Ideas Test

New Community Website

Ordinarily, you'd be at the right spot, but we've recently launched a brand new community website... For the community, by the community.

Yay... Take Me to the Community!

Welcome to the DNN Community Forums, your preferred source of online community support for all things related to DNN.
In order to participate you must be a registered DNNizen

HomeHomeOur CommunityOur CommunityGeneral Discuss...General Discuss...Coding convention for DotNetNukeCoding convention for DotNetNuke
Previous
 
Next
New Post
6/6/2007 4:35 AM
 

is there any coding convention document for DotNetNuke?
I google it all the day, but no result

 
New Post
6/6/2007 8:43 AM
 

No.

I recommend this:  http://msdn2.microsoft.com/en-us/library/xzf533w0(vs.71).aspx

It was discussed on the core team for a while but nothing is enforced.

 


DotNetNuke Modules from Snapsis.com
 
New Post
6/6/2007 2:50 PM
 

Johns link is a very good reference for common development tatics.

If you are looking for the common structure/layout of a dnn module.  For example how the DAL works then you might want to look at Michael Washingtons articles at dotnetnuke.adefwebserver.com


-Mitchel Sellers
Microsoft MVP, ASPInsider, DNN MVP
CEO/Director of Development - IowaComputerGurus Inc.
LinkedIn Profile

Visit mitchelsellers.com for my mostly DNN Blog and support forum.

Visit IowaComputerGurus.com for free DNN Modules, DNN Performance Tips, DNN Consulting Quotes, and DNN Technical Support Services
 
New Post
6/6/2007 4:29 PM
 

Unfortunately, there is not one comprehensive document for this.  In reality, I've seen few good examples of these in my career, though when they do exist, they tend to be incredibly valuable... and in very mature environments (from a product / operations architecture standpoint).

Conventions like CamelCasing are valuable for consistency (no doubt), and we use and enforce many such conventions.  But they don't help with more rigorous or situational requirements like "when is it ok or not ok to use http context".  That's a question which must be answered in a general way first, but then very specifically within your architecture implementation.  And then the guidelines need to become enforceable... precisely because it is hard to know and apply all the recommendations and constraints of a robust system.

An example of a place where some of these objective considerations is documented is the Module Localization Guide (thank you Vicenç) and other docs which you can find here: http://www.dotnetnuke.com/About/Documentation/ProjectDocuments/tabid/478/Default.aspx

The place we really want to be, and are working toward, is a continuous integration and build environment that implements rules & warnings on all of these kinds of considerations.  To use the previous example of http context... would generate a warning or error on build  if used inappropriately (according to architecture constraints) so that the problems would not have to be found later at runtime.

At present, we are building the core and a couple of projects using a robust CI process that we should be able to share for others to use also.  This effort is ongoing and is a pilot implementation... when we roll it out broadly to other projects, we will definitely do so.

Cheers


Scott Willhite, Co-Founder DNN

"It is only with the heart that one can see rightly... what is essential is invisible to the eye. "
~ Antoine de Saint-Exupéry

 
Previous
 
Next
HomeHomeOur CommunityOur CommunityGeneral Discuss...General Discuss...Coding convention for DotNetNukeCoding convention for DotNetNuke


These Forums are dedicated to discussion of DNN Platform and Evoq Solutions.

For the benefit of the community and to protect the integrity of the ecosystem, please observe the following posting guidelines:

  1. No Advertising. This includes promotion of commercial and non-commercial products or services which are not directly related to DNN.
  2. No vendor trolling / poaching. If someone posts about a vendor issue, allow the vendor or other customers to respond. Any post that looks like trolling / poaching will be removed.
  3. Discussion or promotion of DNN Platform product releases under a different brand name are strictly prohibited.
  4. No Flaming or Trolling.
  5. No Profanity, Racism, or Prejudice.
  6. Site Moderators have the final word on approving / removing a thread or post or comment.
  7. English language posting only, please.
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out