6.0.0-git
2024-04-26

Diff for Doc/Dev/Refactor between and 1

[[toc]]

+ Horde_Refactor

A Library and Tool Set for refactoring code

++ Bugs

List any tickets on http://bugs.horde.org/ that cover this issue or are relevant to it.

++ People


++ Description

Horde_Refactor is a commandline tool to enforce quality in code and documentation
Refactoring is governed by Rules which implement detection and change of content violating the rule.

Currently, two formal rules are implemented:
- php4 constructor handling: Ensure a php5 constructor exists if a php4 constructor is found and, if needed, swap positions to ensure compat.
- FileLevelDocBlock: Ensure that a file level doc block with at least certain information is present in all class files.

Some Horde_Refactor Rules may or may not need a configuration file.
Configuration Options for a Horde\Refactor\Rule\Base descendent Foo are defined in a Horde\Refactor\Config\Base descendent class of the same name (if any).

This file can sport default values. To override these, provide a config file 

TODO: Example


++ Resources

Include links to protocol descriptions, specifications, RFCs, external applications, presentations on http://horde.org/papers/ or elsewhere that are relevant, articles, API docs from http://dev.horde.org/ - anything that might be useful to someone working on this.


----
Back to the ((Project|Project List))