Source code documentation standards - Inventory - BS Source

What are best practices for documation in a web development project?

Sep 18, 2007 by Sergio Fantasia | Posted in Programming & Design

I have hired a web development team to build a dynamic website which will be the core platform for a business I am starting. I got strong advice to make sure that they keep good documentation, so I am not held hostage by their understanding of the code

Comments placed into programming code usually are just what you described - short snippets comprising a brief explanation of that function does or variable is, etc.

They're meant for someone who is familiar with that programming language,

joyaz711 | Sep 18, 2007

BNA Books Announces the Publication of the Fourth Edition of "ERISA Litigation"

22.05.12

What You Should Know About Comments on Sacbee.com

Sacbee.com is happy to provide a forum for reader interaction, discussion, feedback and reaction to our stories. However, we reserve the right to delete inappropriate comments or ban users who can't play nice. ( See our full terms of service here. )

Here are some rules of the road:

• Keep your comments civil. Don't insult one another or the subjects of our articles. If you think a comment violates our guidelines click the "Report Abuse" link to notify the moderators. Responding to the comment will only encourage bad behavior.

• Don't use profanities, vulgarities or hate speech. This is a general interest news site. Sometimes, there are children present. Don't say anything in a way you wouldn't want your own child to hear.

• Do not attack other users; focus your comments on issues, not individuals.

• Stay on topic. Only post comments relevant to the article at hand.

Source: Sacramento Bee

The Standard Apps For Windows Phone 7

So Channel 9 showed off the apps that Microsoft has provided for Windows Phone 7 (which are really partially intended for developers since the ...

Unit testing for web application integrity | Clearcode

by Clearcode

From Object Under Test (OUT) to Application Under Test (AUT) to System Under Test (SUT), software developers can perform operations whose goal is to find out glitches and errors in source code. Unit testing, in short, is a technique for checking source code, starting from its smallest testable parts by running manual or automated tests that imitate functions of units....

Read more...

Source code documentation standards - Bookshelf


Computerworld
124 pages 		Computerworld

1982-04-12
The installation had rigid documentation standards that were universally ... Flexible and non-procedural, MARK V generates complete MFS source code and ...
Code Complete Code Complete

Creator: Steve McConnell | Computers - 2009
--Anonymous External Documentation Documentation on a software project consists of information both inside the sourcecode listings and outside them—usually ...
Core python programming
771 pages 		Core python programming

Creator: Wesley J. Chun | Computers - 2001
New to Python? This is the developer's guide to Python development!
Publisher: Prentice Hall Ptr
Java in a nutshell
1224 pages 		Java in a nutshell

Creator: David Flanagan | Computers - 2005
When you specify a Java source file for javadoc to process, ... Documentation for this package is included in the standard documentation bundle for Java 1.2 ...
Publisher: O'Reilly Media
Computerworld
174 pages 		Computerworld

1994-05-23
UDM defines a standard set of information about “assets” -—- such as source code , documentation or specifications — that reuse libraries should be able to ...

Source code documentation standards - News


LDRA Tools Integrate IEC 61508 Compliance Across the Software Lifecycle
SYS-CON Media (press release) - Mar 01, 2011
LDRA, the leading provider of automated software verification, source code analysis, and test tools, launches support for the IEC 61508 and IEC 61508:2010 standards, functional safety standards for electrical/electronic/programmable electronic (E/E/PE)

MadCap Launches Newest Versions of MadPak and MadPak ML Suites Featuring ...
PR Newswire (press release) - Mar 01, 2011
Meanwhile, new accessibility features automate much of the process of ensuring that documentation meets government standards for supporting the vision and hearing impaired." Olivier added, "At the same time, we've also extended our commitment to

GrammaTech Streamlines ISO 26262 Compliance for Functional Safety in ...
PRLog.Org (press release) - Mar 02, 2011
In the report, NASA described CodeSonar as a “strong static source code analysis tool from GrammaTech that uses a different technology for detailed inter-procedural source code analysis.” The full NASA Engineering and Safety Center Technical Assessment

9 Key Legal Developments Facing Hospitals
Becker's Hospital Review - Mar 01, 2011
The PPACA imposed additional reporting obligations and mandatory community benefit standards on tax-exempt hospitals. Under the Internal Revenue Code, as amended by PPACA, a hospital must comply with specific requirements to be treated as exempt under

Alert: What's Coming for Open Source CMS in March 2011
CMSWire - Feb 28, 2011
As for the Composite C1 community, members have contributed back Russian translations for the admin UI and the documentation. The first community patches were also integrated into the source code and developer ratings. Additional free feature patches