1 / 12

Document Your Access Database With Visual Basic

Document Your Access Database With Visual Basic. Presented by Joseph J. Sarna Jr. JJS Systems, LLC. Documentation Is a Necessary Evil!. Does the client require documentation? What do follow-on developers need to know about your application? What do YOU need to know six months from now?.

gomer
Download Presentation

Document Your Access Database With Visual Basic

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Document Your AccessDatabase With Visual Basic Presented by Joseph J. Sarna Jr. JJS Systems, LLC

  2. Documentation Is a Necessary Evil! • Does the client require documentation? • What do follow-on developers need to know about your application? • What do YOU need to know six months from now?

  3. Types of Documentation • We need to provide: • Database documentation • File format documentation • Registry entry documentation • Project and code documentation

  4. Database Documentation • Tables • Field names, data types, descriptions, valid data ranges, etc. • Views/Queries/Stored Procedures • Definitions and SQL strings

  5. File Formats Documentation • Layouts of any special file types used • XML schema • Ini file formats • Application specific files

  6. Registry Entries Documentation • Locations and purposes of all registry entries • Location and purposes of all Active Directory interactions (additions if users, roles, groups, etc.) • Do not need to include entries made by Setup program

  7. Project & Code Documentation • Directory structures of files • Reporting formats • Technical specifications • Code procedures

  8. Using Visual Basic to Generate Database Documentation • DBDoc.vbp • By Tim Patrick, from Visual Basic Programmers Journal, July 2001 - http://www.vbstyleguide.com/ • This application reads the database structures of tables using ADO and ADOX and then writes the document to an HTML file. • Modified by J. Sarna to include Views/Queries

  9. ADO Object Models • Three object models of ADO provide the functionality found in DAO. • ADO • Microsoft ADO Extensions for DDL and Security (ADOX) • Microsoft Jet and Replication Objects (JRO). mk:@MSITStore:C:\Microsoft Visual Studio\MSDN\2001JUL\1033\techart.chm::/html/daotoado.htm

  10. ADO and ADOX • The ADO model allows access and manipulation of data through any OLE DB provider • The ADOX model contains objects for data definition (such as tables, views, and indexes) and creating and modifying users and groups. • With ADOX, one can control database schema and grant and revoke permissions on objects to users and groups

  11. DBDoc Example Code C:\Visual Basic Projects\DBDoc\DBDoc.vbp • Add a reference to Microsoft ActiveX Data Objects 2.5 Library. • Add a reference to Microsoft ADO Ext. 2.5 for DDL and Security.

  12. Closing • Document your project for your own safety! • Find methods that will automate this documentation

More Related