documentation

I always learned that doing maximum code coverage with unit tests is good . I also hear developers from big companies such as Microsoft saying that they write more lines of testing code than the executable code itself. Now, is it really great? Doesn't it seem sometimes like a complete loss of time which has an only effect to making maintenance more difficult ? For example, let's say I have a method DisplayBooks() which populates a list of books from a database. The product requirements tell that if there are more than one hundred books in the store, only one hundred must be displayed . So,

http://www.cn-cuckoo.com/2010/04/18/make-a-android-develop-environment-1512.html 在本文写作时，Android SDK的最新版本是2.1。现在，我们来看一看如何在Windows平台下构建Android 2.1开发环境。 先期需要下载的软件包如下： 1、JDK 1.6+ 2、Android SDK 1.6 3、Android SDK Setup 4、Eclipse IDE for Java Developers 看到这些，可能心急的朋友会禁不住问：“不是要构建Android 2.1开发环境吗？怎么还要下载Android SDK 1.6而不是2.1呢？” 没错，是要讲怎么构建Android 2.1开发环境。但是，经过几次尝试，我发现直接下载安装Android SDK 2.0和2.1有问题。什么问题？简单地说，就是这两个最新版本的SDK包中都不包含adb.exe文件，无法在Eclipse中指定Android SDK的位置（也就意味着没法使用Eclipse来开发）。因此，这才走了一条曲线救国的道路；也许，正如我自己的尝试所证实的：Android SDK 2.0和2.1实际上都是升级包，而不是完整的开发包。我比较了一下，Android SDK 2.0和2.1的大小分别是76.6MB和77.3MB，而Android

I have heard that jQuery UI includes a Color Picker but could find little documentation regarding it. Does it exist? Any decent documentation on how to implement it? I found this: http://docs.jquery.com/UI/Colorpicker But using: $("#colorpicker").colorpicker(); does not work, with Firebug telling me .colorpicker(); is not a method! It seems to work fine, unless I put it in a dialog UI where it then decides to break. You can find some demos and plugins here. http://jqueryui.pbworks.com/ColorPicker Perhaps I am very late, but as of now there's another way to use it using the jquery ui slider .

I'm working on a project where a c++/cli library is being used primarily from a c# application. Is there any way to make the code comments in c++/cli visible to c# intellisence within visual studio? Assuming there isn't, what would be the best way to document the c++/cli code to enable its easier use from c# (and within c++/cli of course)? What is you opinion on XML comments vs doxygen vs other tools (which)? Zoinks I have gotten it to work as follows: Use XML style comments for your C++/CLI header entries. This means the full XML comment is required (triple-slash comments, <summary> tag at a

What does it take for online documentation to be helpful and interesting to read? Disclamer: While this question has selfish origins (I'm writing documentation, and, naturally, want it to be the best one out there), I'm sure other people can take avantage of the answers. Additionally, while documentation isn't programming, I still think it's suitable to ask this here, as you need to document stuff if you program stuff. Elaboration: This question is specific for online documentation, because I think there is a great difference between a tome in 1500-something pages and the dynamics of a webpage

I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.org/eclox/ ). I would like find out, how can it automatically generate a "empty" doxygen comment, which could be filled out later or what is the better choice for a documentation eclipse plugIn? For example for a function: void f(int p1, int p2, ...), it should generate: /*! \brief ... \param p1 ... .. */ PS I'm using for mainly the c/c++ languages tauran See updated solution . Old answer: In eclipse helios in window -> preferences you can do: c/c++ -> Code Style -> Code Templates

Few years back everybody in our shop was crazy with UML . Now everybody seems to have cooled off. I am curious if there is still widespread use of UML in software projects. If so, is this usage limited to whiteboarding? Do you use it for documentation? Do you use tools to generate code from it? Related: Is UML Practical? I prefer the agile adoptation of UML (e.g. white board sketches) over the waterfall adaptation of UML (e.g. excessive documents of elaborate diagrams drawn in Visio). UML is still useful for explaining a design to someone else. E.g. the composite design pattern is easy to

Short version : Can I emulate the documentation of Normal in package stats using roxygen ? Long version : I'm working on a package and was trying make the documentation more readable by having a number of functions with common inputs/parameters collected under one heading, which will be a generic reference to the group. Each function should still be available to the end user independently. I took as inspiration the documentation for Normal which gives a number of methods related to the normal distribution e.g. stats::dnorm() . When I search ?dnorm I find the name of the help section is Normal

What are your approaches to generating some sort of human-readable documentation from WSDLs? In the past I've used WSDL viewer (by Tomi Vanek) and I'm happy with the results, but I'm interested in any possible alternatives. I've also heard of x3sp , but I haven't tried it. I tried several alternatives TechWriter for Web Services : Really powerful, but HTML output was (see comments) multi-file. Also, comments indicate it is retired, but that is no longer the case. <oXygen/> XML Editor : It doesn't process embedded schema. Altova XML Spy : It doesn't process anonymous types. and ended up