Solved

developing code libraries

Posted on 2006-06-14
3
259 Views
Last Modified: 2012-08-14
Hi

I work for a small company who needs to start developing libraries of their reusable code and I would liek some advice about how other people do it

What do you use to document your libraries?

How do you let programmers know what code is available in the libraries and what it does?

Are there any guidelines/conventions to follow?

Any advice or inforamtion about how your company does this is much appreciated.

Thanks a lot
andrea
0
Comment
Question by:andieje
  • 2
3 Comments
 
LVL 20

Accepted Solution

by:
REA_ANDREW earned 500 total points
ID: 16901260
HI, coincidentally <--hope that is spelt correctly lol, I have just made my own. First off here is what to do. Yes you can make Classes in Visual Web Developer, but the best way is to make what you want and that is a class library. So, to begin with I use the Express Edition of Visual C# and I choose to create a Classs Library(.dll).

In here you create your Namespaces, and subsequent classes.

An important point here is to use the three slashes XML Summary, as this gives the tooltip in the intellisense, when the user types in the namespace, it will show all available functions and such for that namespace. An example of the XML Summary which goes directly above each function is so:

        /// <summary>
        /// This is the first Option. Supplying a String;
        /// </summary>
        /// <param name="s"></param>

when you want to create a summary just type /// and the relevant rest will be auto completed for you.

When you have written your class library, be sure to save as a .dll.cs file first which will happen anyway, and then you click build.  A good tip here to save time is to go to view>OutpUt, and then click build and you see where the program has compiled your class library to.  Usually Bin Folder> Release Folder.

Then in your web projects, make sure you have the bin folder in the root of the directory, and choose add reference in the menu. This will then add your ddll. Also, you will need the reference to the assembly at the top of your code, for example I named my namespace, AndysToolKit.Security so in my .cs web page I used this at the top

using AndysToolkit.Security;
0
 
LVL 2

Expert Comment

by:rraghvendra
ID: 16901341
If you are looking for class of data layer then i advise u can go for Microsoft Enterprise Library.
These are free and standard...
for normal class u  can use following

Use below at class level
'************************************************************
' Class:    clsGenerateReport
' Purpose:  This Module have following functionality.
'           1. Get crystal report dynamicly from database report and export it into seleected format.
'           2. FTP the file to a location mentioned .
'           3. Maintain error Log and Detail log.
' Developed By: abc
' Start Date: 3/18/2006              End Date: 03/27/2006
'************************************************************


Use below at function level

  '------------------------------------------------------------------------------------------
        ' Function Name     : sbFTPTransfer
        ' Author            : abc
        ' Purpose           : This Function used to Transfer files to the FTP Server
        ' Created on        : 03/23/2006
        ' Change History    :
        '------------------------------------------------------------------------------------------

       
0
 
LVL 20

Expert Comment

by:REA_ANDREW
ID: 16901806
Here is a good tutorial that goes through in detail everyhting I was trying to state in my post

http://www.c-sharpcorner.com/2/pr12.asp
0

Featured Post

Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Suggested Solutions

In an ASP.NET application, I faced some technical problems. In this article, I list them out and show the solutions that I found.  I hope it will be useful. Problem: After closing a pop-up window, the parent page should be refreshed automaticall…
Introduction This article shows how to use the open source plupload control to upload multiple images. The images are resized on the client side before uploading and the upload is done in chunks. Background I had to provide a way for user…
A short film showing how OnPage and Connectwise integration works.
A company’s greatest vulnerability is their email. CEO fraud, ransomware and spear phishing attacks are the no1 threat to a company’s security. Cybercrime is responsible for the largest loss of money to companies today with losses projected to r…

948 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

20 Experts available now in Live!

Get 1:1 Help Now