The following software packages have been instrumental for development of CleanCode web pages, tools, and code libraries. Most are freeware; some are my own CleanCode tools.
| Web Page Generators |
pod2html: A standard Perl utility to convert POD comments into HTML.
pod2htmltree: A CleanCode utility, leveraging pod2html, to generate a complete HTML documentation set for a Perl library. javadoc: A standard Java utility to convert Javadoc comments to HTML and generate a complete HTML documentation set for a Java library. XmlTransform: A CleanCode utility to generate a complete HTML documentation set from arbitrary XML files. HTML::XGenerator: A CleanCode utility to generate dynamic HTML pages in a CGI environment. ndoc: A .Net utility for generating a complete HTML documentation set. (The main site for ndoc seems to have gotten stuck at .Net 1.1, but the first link has a workable version for .Net 2.0. GhostDoc: A .Net utility for generating XML documentation stubs. |
|---|---|
| Web Site Support |
CoolMenus: A very flexible menu generation tool. [JavaScript]
AXS Visitor Tracking: A traffic monitoring tool from Fluid Dynamics that can literally be installed on a server in 10 minutes or less! It includes an easy-to-use administrative interface that can slice the collected data dozens of ways. [perl] Search Engine: Also from Fluid Dynamics, this search engine hooks up quickly, is extremely configurable, and very intuitive. SourceForge: There are a variety of other vital services that I did not have to handle as SourceForge so kindly provides them as a matter of routine to all hosted sites, including: bug tracking, forums, mailing lists, version tracking, file repositories, file downloading, and more. Xenu Link Sleuth: A very fast, multi-threaded link checker for an entire website. Apache: The ubiquitous web server. |
| Editors and Development Tools |
Eclipse: an IDE for Java (and others)
Vim: The Unix (and Windows!) vi text editor with syntax highlighting (for virtually any language), extensibility, and macro capability. Html-Kit: an html editor/previewer with the Html-Tidy validator from W3C built-in. XmlSpy: an IDE for XML, XSLT, and Schema Expresso: an IDE for regular expressions--great for the beginner or the expert, this provides a designer for building regexs, an evaluator for testing them, and lots more! Snippet Compiler: Creates on-the-fly .NET projects; handy for a "scratchpad". FxCop: A powerful lint for .NET. Net Reflector: A .NET class and documentation browser. SourceMonitor: An interesting read, this tells you about the complexity of your .NET source code. FreeMind: A graphical outlining tool (referred to as "mind mapping" software). InnoSetup: An installer-generator for .NET. While .NET provides a couple different ways to generate installers, I find InnoSetup a lot less confusing to use. It uses a wizard to interview you, then generates a script for you. As you update versions, etc., you then work on the script itself which is quite straightforward. |
| Test Tools |
NUnit: A unit test framework for .NET.
TestDriven: An Nunit plugin to run unit tests inside Visual Studio. NCoverExplorer: A .NET code coverage tool. Works in conjunction with TestDriven to test your code, then report on what was touched, down to the smallest piece of code in your source file. JUnit: A unit test framework for Java. |
| File Management |
Subversion: The pre-eminent open-source, source-control system for personal or enterprise use. Includes branching, tagging, network and multi-user support, file annotation (i.e. who is responsible for each and every line in a file), version graphing, and more.
TortoiseSVN: TortoiseSVN is the separate UI for SubVersion under Windows; simply amazing. Examdiff: A graphical text file comparison tool, allowing toggling line numbers, editing either compared file, setting font sizes, and shifting between horizontal and vertical orientation. WinMerge: Similar to Examdiff, this has less flexibility in the comparison, but adds the tremendous ability to merge selected differences. Also, it does directory comparisons, though not as fancy as Filesync. WinSCP: A Windows Explorer-like file viewer for a remote server over a secure SSH channel. WinSCP provides the capability to both explore the remote server and copy files easily between your local machine and the remote server. Putty: A terminal emulator for working on the remote server. Pageant: An authentication agent used by Putty and WinSCP, alleviating the need for manual authentication each time connecting to a server. WinDirStat: Provides a visual display of your hard disk space, arranging file blocks by relative file sizes. I had been using SpaceMonger until recently but it is no longer free. Filesync: An outstanding, easy-to-use directory comparison and synchronization tool. SyncBack: A very handy, personal backup tool. Also comes in a paid version, but the free one is very good. Novatix ExplorerPlus: A useful file manager due in large part to: built-in quick-viewer, favorites list, transparency of zip files, dual-pane viewing, and contextual file searching. HashCalc: For verifying those large binary downloads, this calculator will generator MD5, SHA-1, and many more checksums. |
| Development Languages |
Sun's Java and JDK
ActiveState's Perl for PCs. JavaScript and JScript: ECMAScript for browser (client-side) programming. |
| Image Manipulation |
Paint.NET: An excellent step-up from Windows basic Paint program; a worthy rival to Photoshop.
IrfanView: Another good image program, though I prefer the user experience with Paint.Net. IrfanView offers one vital feature that Paint.Net does not, however, the ability to save icon files (.ico). ScreenSeize: An old PC magazine favorite to capture screen shots. PDF reDirect: A clean, easy-to-use, well-supported tool for generating PDF files from any program. |
| Database |
SQL Server 2005 Management Studio Express: This is the SQL Server 2005 client, available at no charge, and it connects to both 2005 or 2000 databases.
Sql Prompt 2.0: Provides two valuable time-savers while typing SQL: keyword completion (type the first few letters of a table and it auto-completes the rest) and macro substitution (type "obrd" and it substitutes "order by readingDateTime desc"). Works with QueryAnalyzer or the SS2005 Mgmt Studio above. Version 2 is free and works just fine, if you can find it; the newer version 3 is not. |
| Other Resources |
Sitemap globe: The icon for the sitemap on every page
is a modified version of the original from
GraphicMaps.com.
CleanCode logo font: The font is Bubble 1 (file name gfscus1d.ttf) available from GRSites.com. GRSites.com is a distributor, not a creator, of free fonts. Unfortunately, they do not have any information about the author of this illustrious font. If anyone knows of its origin, please let me know so I can issue the appropriate credit here. Favelets: The handy draggable buttons used for validation, window sizing, etc. (sprinkled throughout the web guidelines section) come from tantek.com. |