Search Results

Search found 93727 results on 3750 pages for 'code documentation'.

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

• Hyperlinked, externalized source code documentation

  - by Dave Jarvis

  Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc.), an IDE could provide semi-lock-step panels…

  Read the article

• Where to put code documentation?

  - by Patrick

  I am currently using two systems to write code documentation (am using C++): Documentation about methods and class members are added next to the code, using the Doxygen format. On a server Doxygen is run on the sources so the output can be seen in a web browser Overview pages (describing a set of classes, the structure of the application,…

  Read the article

• How to keep word document, html and pdf documentation aligned

  - by dendini

  Is there a way to write documentation in a WYSIWYG editor which can then export into HTML, WORD and PDF and keep copies synchronized? This documentation are mostly technical notes and some contextual help for some softwares so they must contain images and some styling, they are not programmer's documentation (API list or functions list) for…

  Read the article

• Reusable VS clean code - where's the balance?

  - by Radek Šimko

  Let's say I have a data model for a blog posts and have two use-cases of that model - getting all blogposts and getting only blogposts which were written by specific author. There are basically two ways how I can realize that. 1st model class Articles { public function getPosts() { return $this->connection->find() …

  Read the article

• SDLC/Deployment/Documentation ERP/framework that minimizes developer misery

  - by foampile

  I was wondering if there are favorite SDLC/Deployment/Documentation/Versioning ERP/frameworks that work with popular SDLC methodologies, such as Agile, that minimize developer exposure to what most programmer hate to do most -- PAPERWORK ? Often, release management is extremely inefficient and there is a lot of data duplication across…

  Read the article

• documentation of typescript code

  - by Max Beikirch

  my question is rather short: How do I document typescript code properly? I found out that for projects becoming bigger and bigger, it is important to look at a function and immediately know parameters, what it returns and side-effects etc. It is tiring to have just a bunch of comments before a function, most of the time these 'blocks'…

  Read the article

• Comprehensive system for documentation and handoff of developer project

  - by Uzumaki Naruto

  I work on a technology team that typically develops projects for a period of time, and then hands off to other groups for long-term maintenance and improvements. My team currently uses ad hoc methods of handing off documentations, such as diagrams, API references, etc. Is there a open source solution (or even proprietary one) that…

  Read the article

• Is extensive documentation a code smell?

  - by Griffin

  Every library, open-source project, and SDK/API I've ever come across has come packaged with a (usually large) documentation file, and this seems contradictory to the wide-spread belief that good code needs little to no comments. What separates documentation from this programming methodology? a one to two page overview of a…

  Read the article

• PDF or ebook Java API documentation

  - by AmaDaden

  Since I have a long train ride to and from work I was wondering if there is a version of the Java API documentation floating around that I could put on my Kindle. It would be nice on the rare occasion I get something in my head that I want to think about some more. I know I can browse the web through the Kindle but coverage…

  Read the article

• Encourage the use of markup files as documentation in enterprise [closed]

  - by linquize

  To make it eaiser to do version control and diff files of documentation, use markup files, such as HTML: html/xhtml, XML: docbook, Wiki: markdown to replace doc/docx. docx is too complex and lengthy. For html, no extra document generation required. Programmers can write html directly and end users / managers can use…

  Read the article

• Seeking advice on system documentation

  - by Shadders

  I have a rating engine (it is basically an algorithm) which when I started had no formal documentation. We have created a functional specification/decomposition which is our business level document but now I need something more technical (a technical specification). What I am struggling to understand is what that…

  Read the article

• How to Automate your Database Documentation

  - by Jonathan Hickford

  In my previous post, “Automating Deployments with SQL Compare command line” I looked at how teams can automate the deployment and post deployment validation of SQL Server databases using the command line versions of Red Gate tools. In this post I’m looking at another use for the command line tools, namely using…

  Read the article

• What are the preferred documentation tools for the major programming languages?

  - by Dave Peck

  I'm interested in compiling a list of major programming languages and their preferred documentation toolsets. To scope this a bit: The exact structure of the answer may vary from language to language, but there appear to be two aspects common to all languages: (1) in-code syntax for documentation, and (2)…

  Read the article

• A big flat text file or a HTML site for language documentation?

  - by Bad Sector

  A project of mine is a small embeddable Tcl-like scripting language, LIL. While i'm mostly making it for my own use, i think it is interesting enough for others to use, so i want it to have a nice (but not very "wordy") documentation. So far i'm using a single flat readme.txt file. It explains the…

  Read the article

• code metrics for .net code

  - by user20358

  While the code metrics tool gives a pretty good analysis of the code being analyzed, I was wondering if there was any such benchmark on acceptable standards for the following as well: Maximum number of types per assembly Maximum number of such types that can be accessible Maximum number of…

  Read the article

• What code smell best describes this code?

  - by Paul Stovell

  Suppose you have this code in a class: private DataContext _context; public Customer[] GetCustomers() { GetContext(); return _context.Customers.ToArray(); } public Order[] GetOrders() { GetContext(); return _context.Customers.ToArray(); } // For the sake of this…

  Read the article

• Java code critique request [closed]

  - by davidk01

  Can you make sense of the following bit of java code and do you have any suggestions for improving it? Instead of writing four almost identical setOnClickListener method calls I opted to iterate over an array but I'm wondering if this was the best way to do it. Here's the code: /*…

  Read the article

• SQL SERVER – Download SQL Server Product Documentation

  - by pinaldave

  Today I just returned from Bangalore User Group Meeting. Attending User Group meeting is indeed fun and really great experience. The best part of the User Group is meeting like minded people and have a great conversation with them. During the meeting I was asked why one has to go…

  Read the article

• Should we enforce code style in our large codebase?

  - by eighttrackmind

  By "code style" I mean 2 things: Style, eg. // bad if(foo){ ... } // good if (foo) { ... } Conventions and idiomaticity, where two ways of writing the same thing are functionally equivalent, but one is more idiomatic. eg. // bad if (fooLib.equals(a, b)) { ... } // good if…

  Read the article

• Please recommend citations for source code documentation standards

  - by Aerik

  I'm trying to convince another group in my company that they need to provide more documentation in their source code (they want to hand off the code to my group) but they're treating it as a "nice to have". In my view, it's a necessity. I've run a source code analysis tool and…

  Read the article

• Open Source Web-based CMS for writing and managing API documentation

  - by netcoder

  This is a question that have somewhat been asked before (i.e.: How to manage an open source project's documentation). However, my question is a little different because: We're not developing open source software, but proprietary software The documentation has to be…

  Read the article

• Is code maintenance typically a special project, or is it considered part of daily work?

  - by blueberryfields

  Earlier, I asked to find out which tools are commonly used to monitor methods and code bases, to find out whether the methods have been getting too long. Most of the responses there suggested that, beyond maintenance on the method currently being edited, programmers…

  Read the article

• SQLAuthority News – Microsoft SQL Server Protocol Documentation Download

  - by pinaldave

  The Microsoft SQL Server protocol documentation provides detailed technical specifications for Microsoft proprietary protocols (including extensions to industry-standard or other published protocols) that are implemented and used in Microsoft SQL Server to…

  Read the article

• Using automated bdd-gui-tests to keep user-documentation-screenshots up do date?

  - by k3b

  Are there developpers out there, who (ab)use the CaptureScreenshot() function of their automated gui-tests to also create uptodate-screenshots for the userdocumentation? Background: Whithin the lifetime of an application, its gui-elements are constantly…

  Read the article

• Are unit tests really used as documentation?

  - by stijn

  I cannot count the number of times I read statements in the vein of 'unit tests are a very important source of documentation of the code under test'. I do not deny they are true. But personally I haven't found myself using them as documentation, ever.…

  Read the article

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