|
DeveloperNotes
Information for developers
IntroductionThis page is intended for developers or those wishing to download and compile the YAMJ code. Google Group page for developers & skin makers
You can apply to join the group here Project code style
Examplepackage com.my.package;
import java.util.List;
public class MyClass {
private String memberAttribute;
private String blahString;
public MyClass {
}
public void methodA() {
// can use inline comments where necessary
if (memberAttribute == null) {
memberAttribute = "blah";
}
}
public int methodB(List<String> someList) {
int count = 0;
for (String s : someList) {
if (s.contains("abc")) {
count++;
} else {
System.out.println(s);
}
}
return count;
}
}Eclipse formattingFor eclipse, download this file to automatically format the code: Eclipse Format Making code changesPlease follow these simple rules when updating the code base to make it easier for all of us to keep up with the changes that have been made. Release_notes.txtIf you make a code change, before you commit the change you need to update the release_notes.txt file in the config directory. The format of the release notes file should be fairly self explanatory: - {Enhancement/Fixed Defect} #{google code issue number} {google code issue title}with the issues listed in numerical order. Committing Code ChangesWhen committing code changes, you should enter this as the comment: Issue {google code issue number} {google code issue title}as this allows the automatic linking back to the issue from the revision page on the google code site. Additional information about the code update can also be entered. Updating the IssueYou should then update the issue and mark it as "Fixed" with a minimum comment of "Fixed in r????" where r???? is the revision that you have just committed. Skin ChangesIf you make changes that could affect skin makers, please make a post describing the change on this thread in the Networked Media Tank forums so that they can update their skins appropriately http://www.networkedmediatank.com/showthread.php?tid=18631 Updating documentationDon't forget to document the changes you have made, for example add new properties to the PropertiesConfiguration and SkinConfiguration pages. |
Sign in to add a comment
Please add requirement to Java 1.6 and emphasize on the UTF-8 for character encoding.