Search Results

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

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

• What tool/framework to use for technical documentation?

  - by Pangea

  We develop products and frameworks to be used with in our organization. I am looking for programmer friendly documentation tools. I have researched on few options sometime back but couldn't decide which one to use. I am looking for suggestions from the people who already used these tools. docbook: springframework and hibernate use this format and…

  Read the article

• Marking "example usage" in code documentation

  - by Ross

  What the best practice of placing example usage in code documentation? Is there a standardised way? With an @usage or @notes? For example: /** * My Function * @param object id anObject * @usage a code example here... */ function foo(id) { } or /** * My Function * @param object id anObject * @notes a code example here, maybe? */…

  Read the article

• Documentation utility for OpenEdge ABL

  - by glowcoder

  I have a large system in OpenEdge ABL that could use some documentation-love. Currently a team member is working on a utility that can find methods and functions and make some "Javadoc-esque" html pages out of it. It's pretty rough around the edges. Okay, it's like sawblades around the edges. I'm trying to find something like Javadoc or Doxygen…

  Read the article

• What are the benefits and drawback of documentation vs tutorials vs video tutorials [closed]

  - by Cat

  Which types of learning resources do you find the most helpful, for which kinds of learning and/or perhaps at specific times? Some examples of types of learning you could consider: When starting to integrate a new SDK inside an existing codebase When learning a new framework without having to integrate legacy code When digging deeper into an…

  Read the article

• Lua & Javascript documentation generation

  - by Tiddo

  I am in the beginning phase of create a mobile MMO with my team. The server software will be written in JavaScript using NodeJS, and the client software in Lua using Corona. We need a tool to auto-generate documentation for both the server-side and client-side code. Are there any tools which can generate documentation for both Lua and…

  Read the article

• Humor in Documentation

  - by Lex Fridman

  Is a small amount of lighthearted wording or humor acceptable in source code documentation? For example, I have an algorithm that has a message hop around a graph (network) until its path forms a cycle. When this happens it is removed from the queue of the node it last resided on which removes it from memory. I write that in a…

  Read the article

• Is gettext appropriate for internationalizing user help documentation?

  - by Richard JP Le Guen

  On my project, we have po files to internationalize/translate various labels, error messages, button-text etc. We also have separate po files for the entirety of our help documentation, which is included in the product. Is this an appropriate use of gettext - putting entire documents in po files as opposed to just labels and…

  Read the article

• Humor in Documentation

  - by Lex Fridman

  Is a small amount of lighthearted wording or humor acceptable in source code documentation? For example, I have an algorithm that has a message hop around a graph (network) until its path forms a cycle. When this happens it is removed from the queue of the node it last resided on which removes it from memory. I write that in…

  Read the article

• Tool to Create Annotated Directory Structure Documentation

  - by Millhouse

  I've got a moderately complicated application that has been developed primarily by me, and I'm getting ready to bring a few more developers in, and I'm thinking of various forms of documentation that might be helpful. I want to communicate information about the directory structure/layout of the project so the new guys will…

  Read the article

• Documentation of a software project

  - by anijhaw

  I am working with a team that works on a very large software project, we have tons of Documentation that is written in MS WORD format with nohyperlinked indexes, no search ability. Everyday we waste our time trying to find the exact document or reference. I was thinking if there was way or even a professional tool that…

  Read the article

• Differences in documentation for sys.dm_exec_requests

  - by AaronBertrand

  I've already complained about this on Connect ( see #641790 ), but I just wanted to point out that if you're trying to make sense of the sys.dm_exec_requests document and what it lists as the commands supported by the percent_complete column, you should check which version of the documentation you're reading. I noticed…

  Read the article

• Should generated documentation go in version control history?

  - by dukeofgaming

  I'm against compiled stuff going into version control, specially when it comes to compiled binaries, however, my principles are now in question after adding doxygen support for a project. Should the hundreds of files generated by doxygen go into version control?, what is the recommended practice here?, I think the…

  Read the article

• Differences in documentation for sys.dm_exec_requests

  - by AaronBertrand

  I've already complained about this on Connect ( see #641790 ), but I just wanted to point out that if you're trying to make sense of the sys.dm_exec_requests document and what it lists as the commands supported by the percent_complete column, you should check which version of the documentation you're reading. I…

  Read the article

• Updated Master Data Services Documentation and Resources

  - by mattande

  (This post was contributed by Reagan Templin, Lead Technical Writer for the MDS Team) With the release of SQL Server 2008 R2, it’s a great time to check out the updated documentation and resources for the release, and for SQL Server 2008 R2 Master Data Services ("MDS") in particular. As you saw in the last post…

  Read the article

• Commenting/In-Code Documentation Styles

  - by Maxpm

  This might be a stupid question, but it's been in the back of my head for a while and I can't find a decent answer anywhere else. I have a teacher who says we should explicitly list each parameter with a description, even if there's only one. This leads to a lot of repetition: double MyFunction(const int…

  Read the article

• Waterfall model documentation

  - by AjmeraInfo

  I want to create a waterfall model. What do I need to do for that? What type of document are required for that?

  Read the article

• Where should a programmer explain the extended logic behind the code?

  - by SRKX

  I have developed a few quantitative libraries in C# where it is important to understand not only the classic information that goes with the XMLDoc comments (which contains basic information with the method signature) but also the mathematical formulas being use within the methods. Hence I would like to be…

  Read the article

• Using Cucumber or RSpec+Selenium to create end user documentation?

  - by carolclarinet

  Has anyone tried creating end user (potentially online, potentially to be printed) help/documentation out of your cucumber scenarios? Or taken screenshots for use in documentation using RSpec and Selenium RC's ability to do so? For Cucumber, I'm imagining something like: Scenario: If you want to add a…

  Read the article

• Are XML Comments Necessary Documentation?

  - by Bob Horn

  I used to be a fan of requiring XML comments for documentation. I've since changed my mind for two main reasons: Like good code, methods should be self-explanatory. In practice, most XML comments are useless noise that provide no additional value. Many times we simply use GhostDoc to…

  Read the article

• What schema documentation tools exist for PostgreSQL

  - by Brad Koch

  MySQL has MySQL Workbench for designing and documenting your schema, and generates CREATE and ALTER scripts based on your design. We're looking at migrating to PostgreSQL in the near future, and we do need a practical way of documenting and modifying the schema structure. What similar tools…

  Read the article

• Does searching documentation and samples look bad?

  - by Mick Aranha

  I am starting a new job in a company with many developers and media people, the layout of the place is open with computers around a skinny oval, I have worked in small teams and programming embedded C, the jobis for objective C I'm still in a medium stage, so I know what I don't know…

  Read the article

• Generate HTML pages from some template

  - by Appu

  I have an open-source project for which I have to generate HTML pages to put on the web. I wanted to keep everything as simple HTML pages. The problem with this approach is if I need to change the design, I have to goto all the pages and change it. This will be tough as I have lot of…

  Read the article

• How to document experimental or incomplete APIs like @deprecated?

  - by Michael Levy

  Is there a good term that is similar but different than "deprecate" to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely change? (Yeah, I know, those methods shouldn't be public, yada yada yada. I didn't…

  Read the article

• I'm tasked with leading the documentation effort for an existing, entirely undocumented, software product - what resources are there to help me?

  - by Ben Rose

  I'm a software developer at a technology company. I have been tasked with leading the documentation effort for the product I work on. The goal is to produce documentation internal to developer, and the project spills over into the business side, where it covers requirements…

  Read the article

• Are there good resources for leading documentation for an existing software product having none?

  - by Ben Rose

  Hello. I'm a software developer at a technology company. I have been tasked with leading the documentation effort for the product I work on, both internal to developers as well as spilling over into facilitating the business side of requirements documentation. This internal…

  Read the article

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