Search Results

Search found 8543 results on 342 pages for 'documentation'.

Page 5/342 | < Previous Page | 1 2 3 4 5 6 7 8 9 10 11 12  | Next Page >

• MySQL Procedures : Standard/Best Place For Code Documentation?

  - by rlb.usa

  I'd like to put a paragraph or so for documentation on each of my MySQL procedures: date, author, purpose, etc. Is there a standard, accepted, or best place to put this kind of documentation? For example, In MSSQL, some IDE's will generate a template for you to start coding your procedure; it comes with a little place for code documentation. USE [MyDatabase] GO /****** Object: StoredProcedure [dbo].[StoreRecord] Script Date: 04/29/2010 09:21:57 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO -- ============================================= -- Author: -- Create date: -- Description: -- ============================================= ALTER PROCEDURE [dbo].[StoreRecord] -- ... more code ...

  Read the article

• Why do software engineers hate writing documentation?

  - by Stewart Johnson

  I ask because I quite enjoy it! I'm talking about design documentation and implementation notes (NOT user manuals), which are non-existent in most of the codebases I've been handed. I can understand why a developer wouldn't want to write requirements (that's the analyst's job) or the user documentation (that's a technical writer's job) but I don't get why developers hate writing design docs. I don't think I would feel as if I'd finished the job if I only wrote the code and walked away -- mainly because when I've been introduced to code-only situations I've seen how hard it is to figure out what's been done and what the software does. I would hate for people to suffer the same situation when inheriting my code. What makes you loath writing supporting documentation for your code?

  Read the article

• How to document a Symfony based REST API (similar to enunciate's documentation capabilities)

  - by Dominic

  If I have a REST based service written in the Symfony [symfony-project.org] framework (i.e. PHP), is there any decent tools/frameworks out there that will parse my code and generate API documentation? The Java based framework enunciate has documentation capabilities similar to what I need, you can view an example of this here: http://enunciate.codehaus.org/wannabecool/step1/index.html. I understand the premise of REST based services are supposed to be self evident, however I was after something that would generate this documentation for me without the need to manually write up all my endpoints, supported formats, sample output etc. Thanks

  Read the article

• What format is your documentation in?

  - by Ek0nomik

  I am going to be writing documentation for two web services that I developed, and I started wondering what people on here do for documentation. Do you create it in an HTML file so it can be viewed in the browser? Word document? Wiki? What do you guys/gals use? I was originally leaning towards creating an HTML page since it seems a little more open and friendly than a word document. Plus I can use the prettify javascript to make code samples look nice. Our company has a Sharepoint though, so an HTML file may not be the best choice given that most documentation is put up in spreadsheets and word documents.

  Read the article

• Database Documentation with `SQL Doc 2`

  - by mehdi lotfi

  I use SQL Doc 2 for documentation my database. But this tools not support following expect : Add diagrams in documentation. Add Additional description for each object such as tables, columns and etc. Customize output format. Add custom link for each object. Add Analyze business description of created tables, columns and etc Some time need to explain records of each table such as records of literal tables. How Can support above request in SQL Doc 2? Do exists a tools for documentation database with above request?

  Read the article

• Documentation vs tutorials vs video tutorials - which one's better?

  - by Cat

  As a developer/software engineer, what would you say are the most helpful resources when attempting to learn and use a new system? If you had to integrate a new SDK into your codebase/application, which one of the following options would you much rather go with? documentation tutorials video tutorials Same question for learning a new framework (e.g. writing an iOS app, learning Python, integrating the Android SDK, etc.). I'm not referring to becoming an expert, just get to know enough to use a system/language/framework properly. This is a pretty general question, but I think it's very relevant to anyone who's doing engineering work, since learning how to use new systems quickly is a very important skill to have. Thank you!

  Read the article

• Framebuffer Documentation...

  - by NoMoreZealots

  Is there any documentation on how to write software that uses the framebuffer device in Linux? I've seen a couple simple examples that basically say: "open it, mmap it, write pixels to mapped area." But no comprehensive documentation on how to use the different IOCTLS for it anything. I've seen references to "panning" and other capabilities but "googling it" gives way too many hits of useless information.

  Read the article

• Objective-C: making documentation

  - by VansFannel

  Hello. I've been developing for Visual Studio and C# for a long time. Now, I'm developing with XCode and Objective-C. On C# I can use /// <summary> to generate documentation. Is there any kind of mechanism like that on XCode to generate documentation? And what kind of comments should I use? Thank you.

  Read the article

• Get Doxygen to show XCode compile errors if documentation is missing

  - by Rob

  I have been successful with this in the past but now I can't seem to find the setting that tells XCode or Doxygen (or both) to display compile errors if documentation is missing. I have looked at the Apple documentation that tells how to create docsets and that works fine but XCode does not throw compiling errors on missing comments in the source code. Anyone know how to get this turned on? Thanks, Rob

  Read the article

• Where is the NUnit.Mocks documentation?

  - by emddudley

  Where is the documentation for NUnit's mocking library, NUnit.Mocks? I can't find anything in their official documentation or wiki.

  Read the article

• WYSIWYG in Doxygen

  - by Adam Shiemke

  I'm working on a fairly large project written in C. The idea was to build a library of modular blocks that can be reused across several platforms. Each module is assocaited with a word document in .docx format (huge pain to diff-merge). In these docs, an interface section is specified, listing datatypes and publicly accessable functions. These were often inconsistant with the actual implementation in code, and wading through all this documentation was a pain. I've been working to switch to doxygen to simplify document managemnet. I haven't found a good way to embed the previously written documentation into the doxygen output. I've copy-pasted them into sections and used modules to group the sources together, but the document sections look ugly in the comments (the output is pretty) and since doxygen takes a while to parse through our code (about 30 mins), validating formatting is a pain. Is there some way to WYSIWIG large blocks of documentation into doxygen? I feel this would improve the number of people documenting their code, and the quality of that documentation. I considered linking to html, but that splits out the documentation. I also considered putting them inline in html, but this also seems like a pain and would mean everyone needs a WYSIWIG HTML edditor (or some html skillz). Any ideas on how to make things easier and prettier? Thanks loads.

  Read the article

• Good App documentation samples

  - by Dkong

  Does anybody know where on the web I can find some good samples of decent documentation. ie documentation templates, perhaps with some stubs? I have looked on the net and haven't seen anything decent.

  Read the article

• Suggestions on documentation of a DB model when using Entity Framework 4

  - by Junior Ewing

  Any experiences on how to document Entity Framework 4 based Database projects? There is the Document and Summary properties on the Entities, but if we want to regenerate the model from the database at some point, it will be lost! Is there some way to map documentation data inside SQL to the Entities in the EDMX file so it is safe. Suggestions of other best practices? Ideally I want to be able to augo generate html/helpfile documentation from the DB when we deploy.

  Read the article

• Graphviz for documentation.

  - by Marcin

  I noticed that doxygen uses the graphviz library for creating diagrams. Have you ever used graphviz for generating documentation? Is it worth learning the graphviz for documentation purposes outside the scope of doxygen? Or am I better off to sticking with a standard data modeling package like Visio? I understand the merits of it as a graphing library, but for trying to represent more complex UML (or similar) is it still worth looking into?

  Read the article

• Are there documentation tools for SOAP web services?

  - by mjustin

  Many tools are available for web service designing, programming and testing, commercial and free. But what is available in the area of documentation? Are there tools which can parse a WSDL and then generate a 'human-readable' documentation in HTML (or PDF)?

  Read the article

• What do you consider good API documentation?

  - by Daniel

  I have always liked the documentation on Java APIs, generally speaking, but I know some people consider them lacking. So I'm wondering, what do you consider a good example of API documentation? Please, include a link or an actual example in any answer. I want to have references that I (and others, of course) can use to improve our own documents.

  Read the article

• asp.net c# online documentation generator

  - by morcovar

  We are developing a very complex eCommerce portal using asp.net c# and the client asked us to make the documentation very similar (look & feel) with ebay api documentation http://developer.ebay.com/DevZone/shopping/docs/CallRef/GetSingleItem.html Do you have any idea what kind of tool they are using and if not do you know anything that can be configured to produce a similar result ? Thank you in advance ! Andrew

  Read the article

• C# documentation generator?

  - by ryeguy

  Is there any kind of documentation generator for C#? Like something that would put the xml-ish documentation right above the method/class declarations? Is there a tool or is it tucked away somewhere in VS 2008?

  Read the article

• Professional way to write project documentation

  - by EugeneP

  What tools and standards do you use to describe your project, database, modules, classes, their interaction for programmers, let's say after the project is finished. Do you use UML? Are there enterprise standards for Java developers, how to write such a documentation let's say from SUN? Are there specific tools that simplify this documentation process & compilation of neccessary docs. If there are good books on project documenting process, please give me links to Amazon.

  Read the article

• Documentation with NDOC3

  - by lkaw

  I am working on a project documentation using NDOC3. The build fails when trying to document 3rd party DLLs (because I do not have the xml documentation for them). How could I address this issue ?

  Read the article

• Component Level Documentation

  - by Jason Summers

  I'm trying to make good on a promise I've made to provide a decent set of documentation for a C# component that I've written. I've done some googling and found templates for software design at high and low level. The problem is that all of the templates seem to be geared towards a complete system design as opposed to individual components and are consequently overkill. Can anyone please point me in the direction of a template geared towards component documentation? Many thanks

  Read the article

• What do you consider a good API Documentation?

  - by Daniel

  I have always liked the documentation on Java APIs, generally speaking, but I know some people consider them lacking. So I'm wondering, what do you consider a good example of API documentation? Please, include a link or an actual example in any answer. I want to have references that I (and others, of course) can use to improve our own documents.

  Read the article

• How do you avoid that server documentation gets out of sync with the actual setup?

  - by Frerich Raabe

  I'm a hobbyist maintaining a small FreeBSD server serving mail via IMAP - it's an exercise in server administration. The setup does have reasonably good documentation (in AsciiDoc format) which recently allowed another person to recreate the entire setup from scratch in less than 30 minutes. However, I noticed that after the initial setup, it easily happens that small changes done to the system (say: inetd gets disabbled, my IMAP server listens on an additional port for ManageSieve connections, a new router is added to the exim configuration) don't end up in the documentation immediately (if at all). My idea was to avoid this problem by (partially?) generating the documentation out of the configuration files and the comments therein - one way to implement this may be to put /etc and /usr/local/etc into some source code management system (say - git) and then run a script which regenerates the documentation on every commit. However, I'm not sure whether that would be overkill and/or too difficult to get right (after all, I don't want complete copies of the source files in my documentation but rather just the diffs). How do other people avoid that the server documentation gets outdated - is there a good way to keep them in sync automatically, or do you just have the discipline to update the documentation the same time you modify the system?

  Read the article

• C# XML Documentation Compiler Warning

  - by ImperialLion

  I am curious as to why I get a compiler warning in the following situation. /// <summary>This is class A /// </summary> public class A { /// <summary>This is the documentation for Method A /// </summary> public void MethodA() { //Do something } } /// <summary>This is class B /// </summary> public class B : A { /// <summary>This does something that I want to /// reference <see cref="MethodA"/> /// </summary> public void MethodB() { //Do something } } The warning states that "XML comment on 'B.MethodB()' has cref attribute 'MethodA' that could not be resolved." If B inherits from A shouldn't the compiler be able to see that method when generating the documentation without me specifying the parent class in the cref? If I change the cref to be cref="A.MethodA()" it works fine, but it seems like that's unnecessary and is a pain to do, especially if I have to go up more than one level. As a note to anyone testing this you have to be sure to "XML documentation file" checked in the Properties - Build in order to see the warning.

  Read the article

• RESTful API Documentation

  - by PartlyCloudy

  I'm going to design a RESTful API soon, thus I need to describe it in order to enable other people to start implementing clients using it. I've looked around a bit, but unfortunately, I've not found any standardized form of describing web-based RESTful services. What I'am looking for is something like JavaDoc, although it don't have to be generated out of any sort of code. I'm also not talking about something like WADL, I rather want to have some human-readable documentation I can hand out. Due to the nature of RESTful web-based services, it should be quite easy to standardize a documentation. It should just list available ressources, corresponding URIs, allowed methods, content-types and describe the availabe actions. Do you have any suggestions therefore? Thanks in advance & Greets

  Read the article

< Previous Page | 1 2 3 4 5 6 7 8 9 10 11 12  | Next Page >