https://msdn.microsoft.com/en-us/library/gg604045.aspx

Published: February 2011

Learn how to plan and manage Application Lifecycle Management (ALM) in Microsoft SharePoint 2010 projects by using Microsoft Visual Studio 2010 and Microsoft SharePoint Designer 2010. Also learn what to consider when setting up team development environments, establishing upgrade management processes, and creating a standard SharePoint development model.

Applies to: Microsoft SharePoint Foundation 2010 | Microsoft SharePoint Server 2010 | SharePoint development tools in Microsoft Visual Studio 2010 | Microsoft Visual Studio Team Foundation Server 2010 | Microsoft SharePoint Designer 2010

Provided by: Vesa Juvonen, Microsoft Corporation | Chris Keyser, Microsoft Corporation

Contents

• Introduction to Application Lifecycle Management in SharePoint 2010
• SharePoint Application Lifecycle Management: An Overview
• Solution Packages and SharePoint Development Tools
• Using SharePoint Designer 2010 as a Development Tool
• Importing Solution Packages into Visual Studio 2010
• Team Development Environment for SharePoint 2010: An Overview
• Setting Up a Team Development Environment for SharePoint 2010
• Models for Solution Lifecycle Management in SharePoint 2010

Download location: https://code.msdn.microsoft.com/spdisposecheck

Update Summary:

I’m happy to announce SPDisposeCheck v14.0.4762.1000 was updated and released today 12/13/2010. 

SPDisposeCheck is a tool that helps developers and administrators check custom SharePoint solutions that use the SharePoint Object Model helping measure against known Microsoft dispose best practices. This tool may not show all memory leaks in your code and may produce false positives which need further review by subject matter experts.

The SPDisposeCheck updated tool remains a standalone command line utility and we’ve added a Visual Studio 2008/2010 IDE Add-In which calls out to the SPDisposeCheck.  This Add-In was originally presented at the SPC 2009 and is now available publically.  In addition this version has been tested with both WSS 3.0 + MOSS 2007 and SharePoint 2010 (Foundation and Server) environments.

Finally, we have added several checks on when “NOT” to Dispose objects instantiated by SharePoint internally.  These newly reported “DO NO DISPOSE” (DND) rules were unreported by SPDisposeCheck v1.3.* .  We would encourage you to run the updated SPDisposeCheck tool on all customized SharePoint projects to help identify areas in code which may lead to memory pressure and server stability issues.  As a best practice you should consider adding this tool to your SharePoint software development life cycle build process and review its output with a subject matter expert on a regular interval.

I plan on posting a follow up on some code examples of when not to dispose object following this initial announcement.

Reference list of Do Not Dispose Rules checked:

• SPDisposeCheckID_600 = 600, //DO NOT DISPOSE: SPListEventProperties.Web
• SPDisposeCheckID_605 = 605, //DO NOT DISPOSE: SPWebEventProperties.Web
• SPDisposeCheckID_610 = 610, //DO NOT DISPOSE: SPItemEventProperties.Web
• SPDisposeCheckID_615 = 615, //DO NOT DISPOSE: SPItemEventProperties.ListItem.Web 
• SPDisposeCheckID_620 = 620, //DO NOT DISPOSE: SPItemEventProperties.Web.Site
• SPDisposeCheckID_625 = 625, //DO NOT DISPOSE: SPItemEventProperties.ListItem.Web.Site
• SPDisposeCheckID_630 = 630, //DO NOT DISPOSE: SPFeatureReceiverProperties.Feature.Parent               
• SPDisposeCheckID_635 = 635, //DO NOT DISPOSE: SPList.ParentWeb & SPListEventProperties.List.Web
• SPDisposeCheckID_640 = 640, //DO NOT DISPOSE: SPWeb.ParentWeb
• SPDisposeCheckID_645 = 645, //DO NOT DISPOSE: SPContext.Site & SPContext.Current.Site
• SPDisposeCheckID_650 = 650, //DO NOT DISPOSE: SPContext.Web & SPContext.Current.Web
• SPDisposeCheckID_655 = 655, //DO NOT DISPOSE: SPSite.RootWeb (Covers -v1 SPSite.LockIssue, SPSite.Owner, SPSite.SecondaryContact checks)
• SPDisposeCheckID_660 = 660, //DO NOT DISPOSE: SPControl.GetContextWeb(..)
• SPDisposeCheckID_665 = 665, //DO NOT DISPOSE: SPControl.GetContextSite(..)
• SPDisposeCheckID_670 = 670, //DO NOT DISPOSE: Microsoft.SharePoint.Administration.SPSiteAdministration.OpenWeb() + 2010
• SPDisposeCheckID_700 = 700, // Microsoft.SharePoint.SPItemEventProperties.OpenWeb() on Sharepoint 2010

Special thanks to the SPDisposeCheck core development team: Sean Thompson, Greg Varveris, Paul Andrew, and Stefan Goßner !

I recently attended the The Great SharePoint Adventure 2010 workshop from Critical Path Training in Tampa , Florida and would strongly recommend this 5 day workshop for all developers looking to sharpen their skills in SharePoint 2010 software development.  Students are provided with a hard copy of the presentation manual (with notes) and a hands-on-lab manual to help re-enforce each topic discussed as well as a soft copy of all the demo code.  Author and MVP Ted Pattison delivered the training for the workshop I attended and he kept things fun and moving along sharing his many years of insight with SharePoint and .NET development.

Module 1 - SharePoint 2010 Developer Roadmap
Module 2 - SharePoint Foundation Development
Module 3 - Visual Studio 2010 SharePoint Tools
Module 4 - Creating Sandboxed Solutions 
Module 5 - Pages and Navigation 
Module 6 - Developing Web Parts
Module 7 - Creating Fields, Site Columns & Content Types 
Module 8 - Creating Lists & Event Handlers
Module 9 - Accessing Data in Lists 
Module 10 - Client Object Model
Module 11 - Developing Workflows
Module 12 - Business Connectivity Services
Module 13 - Web Content Management 
Module 14 - Enterprise Content Management
Module 15 - Extending Search  
Module 16 - Business Intelligence (BI)  
Module 17 - SharePoint Security 
Module 18 - Extending the Visual Studio 2010 SharePoint Tools 
Module 19 - Service Applications

Check out Eric White’s excellent blog post SharePoint Developer Building Blocks: Technologies for Creating SharePoint Applications which will soon become a MSDN Whitepaper.  It’s a great resource if you are jumping into SharePoint 2010 development and want to understand at a high level more about the underlying technologies needed with respect to the developers perspective.

Make sure you read Todd’s excellent blog post SharePoint’s Sasquatch Memory Leak .

SPDisposeCheck: The current version v1.3.1 (January 2009) of SPDisposeCheck utility does not scan for “Do Not Dispose Guidance”.  SPDisposeCheck does a great job drawing your attention to areas of your source code that potentially do not conform with our (Microsoft’s) guidance on Disposing SharePoint objects but you might not be fully aware that it’s not going to report any of the “Do Not Dispose Guidance” listed below.  Until we release the refreshed version of SPDisposeCheck that targets “Do Not Dispose Guidance” you will need to manually review the source code for the guidance on my blog and our Dispose WhitePaper.  The current version of SPDisposeCheck was targeted and tested against Microsoft Office SharePoint Server 2007 but we are working on a update that works with SharePoint Server 2010 Beta 2.

Remember it’s best practice to regularly review your ULS logs for Dispose() related leaks that have occurred during runtime.. SharePoint Server internally is instrumented to report on Dispose related leaks.

“Do Not Dispose Guidance” as of 11/30/2009:

SharePoint 2007 & 2010:

• SPContext.Current.Site
• SPContext.Current.Web
• SPContext.Site
• SPContext.Web
• SPControl.GetContextWeb(..)
• SPControl.GetContextSite(..)
• SPFeatureReceiverProperties.Feature.Parent
• SPItemEventProperties.ListItem.Web
• SPList.BreakRoleInheritance()
  • Do not call list.ParentWeb.Dispose()
• SPListEventProperties.Web
• SPListEventProperties.List.Web
• SPSite.RootWeb
  • Problems may occur when SPContext.Web has equality to the SPContext.Web.. make sure you dispose of SPSite and it will cleanup sub webs automatically
• SPSite.LockIssue
• SPSite.Owner
• SPSite.SecondaryContact
• SPWeb.ParentWeb
• SPWebEventProperties.Web

Changes:

• Microsoft.SharePoint.WebControls.SiteAdminsitrationSelector.CurrentItem
  • When used with WSS 3.0 you must call Dispose(), with SharePoint Foundation 2010 you don’t.
• Event Receivers and properties.OpenWeb()
  • WSS 3.0: When you call properties.OpenWeb() the returned SPWeb will need to call Dispose()
  • SharePoint Foundation 2010: Use the newly introduced SPItemEventProperties.Web property instead of SPItemEventProperties.OpenWeb() for better performance and to avoid the need to call Dispose().

You can download the 10 Developer HOL’s from here (C# and VB.NET).

HOL01 - Developing a Visual Web Part in Visual Studio 2010
This hands-on lab introduces the Visual Studio 2010 SharePoint development environment. It shows how to build a Visual Web Part using LINQ to SharePoint, and how to connect one Web Part to another Web Part on the page.

HOL02 - Developing a List Definition and Event Receiver in Visual Studio 2010
This hands-on lab walks you through building a list definition for SharePoint 2010 in Visual Studio 2010. It also shows how to build an event receiver for the list in Visual Studio 2010 and deploy it to SharePoint. After the list and event receiver are deployed, you can use the developer dashboard to evaluate the performance of the event receiver.

HOL03 - Developing Advanced Web Parts for SharePoint 2010 with Visual Studio 2010
This hands-on lab shows how to build a Web Part using several SharePoint-specific controls in Visual Studio 2010. Investigate advanced built-in Web Parts, including the Data View Web Part.

HOL04 - Developing with LINQ to SharePoint in Visual Studio 2010
This hands-on lab explores a variety of LINQ queries on SharePoint 2010, going into more depth than the introductory hands-on lab. It also walks you through an exercise of creating a custom content type in Visual Studio 2010.

HOL05 - Developing for SharePoint 2010 with the Client OM and REST in Visual Studio 2010
This hands-on lab introduces the Client object model for use in calling SharePoint 2010 APIs from a client machine. It also shows the use of ADO.NET Data Services to call REST services in SharePoint 2010.

HOL06 - Developing a BCS External Content Type with Visual Studio 2010
This hands-on lab walks you through building an external content type for Business Connectivity Services using Visual Studio 2010. It also builds a form for Microsoft Outlook and shows the data being edited offline in Outlook.

HOL07 - Developing a SharePoint 2010 Workflow with Initiation Form in Visual Studio 2010
This hands-on lab walks you through building a workflow in Visual Studio 2010 for SharePoint 2010. You add an initiation form to the workflow and use an external data exchange activity in the workflow.

HOL08 - Developing SharePoint 2010 User Interface with Silverlight in Visual Studio 2010
This hands-on lab walks you through building Microsoft Silverlight applications for use in SharePoint 2010. You will access SharePoint 2010 data in Silverlight using the Client object model.

HOL09 - Developing SharePoint 2010 Sandboxed Solutions in Visual Studio 2010
This hands-on lab walks you through building a Sandboxed Solution Web Part for SharePoint 2010. It will also add code to the Web Part that overloads the limits placed by the sandboxed solution, and you will review how the solution is shut down.

HOL10 - Developing SharePoint 2010 User Interface Ribbon and Dialog Customizations
This hands-on lab walks you through adding a custom action to the SharePoint 2010 ribbon, and creating a Web Part that uses the Dialog Framework.

Guidance for building collaborative applications that extend your LOB systems

The guidance provides value for experienced developers just starting in SharePoint development as well as experienced SharePoint developers looking to expand their skills.

If you are new to SharePoint development, the first step is to study the Training Management application, which is based on Windows SharePoint Services. The documentation and the application can help developers understand the fundamentals of SharePoint development, and compliments other training resources and publications.

For those that already are experienced in developing SharePoint applications, or who have gone through the Training Management application, the Partner Portal application and SharePoint Guidance library demonstrate these advanced areas. You can explore the guidance and Partner Portal reference implementation based upon your areas of interest. The general guidance refers into areas of the reference implementation that illustrate the covered concepts.

This guide enhances product documentation by applying the information to a realistic business situation illustrated in the reference implementations. In many cases, the guidance refers to the product documentation. You can use the guidance to gain initial understanding. You can then use the product documentation for deeper understanding.

Quick Links:

https://www.microsoft.com/spg
https://www.codeplex.com/spg
Download here

What’s included:

Component	Description
SharePoint Guidance Library	A set of reusable components that helps developers manage configuration, build repositories for SharePoint lists, log traces and events, and use service location.
Guide	The documentation includes a variety of topics, such as how to use design and application patterns, how to integrate LOB systems with SharePoint applications, building scalable applications, upgrading SharePoint applications, and using SharePoint capabilities to create, and deploy content. It also includes the design decisions made for the Partner Portal and Training Management applications and explanations of their implementations.
Contoso Partner Portal Reference Implementation	This SharePoint application shows how Contoso created an extranet where it can interact with its partners. Among the items demonstrated are techniques for building manageable and scalable enterprise applications, and how to incorporate publishing and page composition features, flexible navigation, collaboration sites, and LOB integration. It includes more advanced techniques than the Training Management reference implementation and requires Microsoft Office SharePoint Server 2007 with Service Pack 1 or Service Pack 2.
Contoso Training Management Reference Implementation	This SharePoint application illustrates how the Contoso Human Resources department manages its training course offerings. It shows how to solve many basic SharePoint challenges that you might encounter when you develop your own applications. Windows SharePoint Services 3.0 is required.

Channel 9 videos

· Setting up the Contoso RI

· Walkthrough of the Contoso Reference Implementation

· How to use the configuration component?

· How to use the logging components?

· How to use the SharePoint Service Locator?

Authors and Contributors

The Developing SharePoint Applications guidance was produced by the following individuals:

• Larry Brader, Francis Cheung, RoAnn Corbisier, Nelly Delgado, Chris Keyser, Erwin van der Valk, Blaine Wastell, Hanz Zhang (Microsoft Corporation)
• Charles Cho, Mike Chorey (Avanade)
• Kishore Kadiveti, Allvin Muthunayagam, VenkataAppaji Sirangi (Tata Consultancy Services)
• Colin Campbell, Roberta Leibovitz (Modeled Computation LLC)
• Robert L. Bogue (Thor Projects LLC)
• Todd Baginski (Advaiya, Inc)
• Andrew Connell (Critical Path Training)
• John Daniels (Analysts International)
• Tina Burden, Sharon Smith (TinaTech Inc)
• Veronica Ruiz (CXR Design)
• Richard Burte (ChannelCatalyst.com, Inc.)

Many thanks to the following advisors who provided invaluable assistance:

• Microsoft Contributors and Reviewers: Mike Ammerlaan, Paul Andrew, Luca Bandinelli, Eric Charran, Todd Haugen, Rob Howard, Roger Lamb, Steve Peschka, Jim Sturms, Simon Skaria, Aaron Weiker, Mike Wise
• External Contributors and Reviewers: Reza Alirezaei, Darrin Bishop, Jackson Chackungal, Spencer Harbar, Faraz Khan, Matthew McDermott, Maurice Prather, Eric Shupps, Ethan Wilansky, Andrew Woodward

• Stsadm Technical Reference for Windows SharePoint Services 3.0
• Stsadm Technical Reference for SharePoint Server 2007

https://msdn.microsoft.com/en-us/office/dd638301.aspx