Book Image

NHibernate 2 Beginner's Guide

By : Aaron Cure
Book Image

NHibernate 2 Beginner's Guide

By: Aaron Cure

Overview of this book

<p>NHibernate is an open source object-relational mapper, or simply put, a way to retrieve data from your database into standard .NET objects. Quite often we spend hours designing the database, only to go back and re-design a mechanism to access that data and then optimize that mechanism. This book will save you time on your project, providing all the information along with concrete examples about the use and optimization of NHibernate.<br /><br />This book is an approachable, detailed introduction to the NHibernate object-relational mapper and how to integrate it with your .NET projects. If you're tired of writing stored procedures or maintaining inline SQL, this is the book for you.<br /><br />Connecting to a database to retrieve data is a major part of nearly every project, from websites to desktop applications to distributed applications. Using the techniques presented in this book, you can access data in your own database with little or no code.<br /><br />This book covers the use of NHibernate from a first glance at retrieving data and developing access layers to more advanced topics such as optimization and Security and Membership providers. It will show you how to connect to multiple databases and speed up your web applications using strong caching tools. We also discuss the use of third-party tools for code generation and other tricks to make your development smoother, quicker, and more effective.</p>
Table of Contents (19 chapters)
NHibernate 2
Credits
About the Author
About the Reviewers
Preface
Index

XML documentation & GhostDoc


GhostDoc is a great little tool, originally written by Roland Weigelt, which helps you to maintain the XML documents in your code. You can download it from its new home at SubMain, the Developer Tools Division of vbCity.com, LLC.

I'm sure you've seen those great-looking comments preceded by the /// in C# or the ''' in VB.NET, that once written, will provide not only us but anyone else that uses our code IntelliSense information.

Take, for instance, our method to get the roles for a user:

public override string[] GetRolesForUser(string UserName)

Taken out of context, this doesn't really tell us much about what the method does. However, if we add some XML documentation to it, it can be much more informative:

/// <summary>
/// Retrieves a string[] of Roles for a user with given UserName
/// </summary>
/// <param name="UserName">The login name of the user</param>
/// <returns>string[] of role names</returns>
public override string...