Giter VIP home page Giter VIP logo

ef-document-generator's Introduction

About

Project site: https://github.com/timabell/ef-document-generator

Reads a db schema and then adds/updates the documentation in the matching .emdx file.

This is a fork of http://eftsqldocgenerator.codeplex.com/ fixed-up for EF5

Usage

EFTSQLDocumentation.Generator.exe 	\
	-c "server=.;database=yourdatabase;Integrated Security=SSPI"  \
	-i path\to\your\Model.edmx

Arguments

  • -c, --connectionString... ConnectionString of the documented database
  • -i, --input... original edmx file
  • -o, --output [optional] ... output edmx file - Default : original edmx file

What now?

You may want to get the comments to be added to your generated model classes. You can do that by modifying your model.tt file as follows: https://gist.github.com/timabell/74bb6c6bbb7a4de843dc

With that in place you will have consistent model documentation across your schema, edmx and c# model, with the tooling to keep them in sync.

Licence

Apache 2.0 as per upstream: http://eftsqldocgenerator.codeplex.com/license

Download

Get the binary from https://github.com/timabell/ef-document-generator/releases/latest

Links

ef-document-generator's People

Contributors

timabell avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.