Tagged Questions
4
votes
1answer
94 views
Duplicating documentation on interface implementations/overrides good or bad?
So we have an interface like so
/// <summary>
/// Interface for classes capable of creating foos
/// </summary>
public interface ICreatesFoo
{
/// <summary>
/// Creates foos
...
3
votes
1answer
84 views
Does doxygen support templates for the HTML output?
I've documented my code for doxygen, but I don't want the default HTML it gives. I know I can customize it by providing custom CSS, headers, footers, etc. (like GNOME does), and how I can add common ...
0
votes
0answers
121 views
What is Highcharts using to generate their JavaScript api documentation? [closed]
The Highcharts 3.0 beta was announced today and there's a healthy discussion occurring on Hacker News. In the thread of comments about the release was a comment from Torn about what Highcharts is ...
1
vote
0answers
86 views
documentation of typescript code
my question is rather short:
How do I document typescript code properly?
I found out that for projects becoming bigger and bigger, it is important to look at a function and immediately know ...
6
votes
2answers
128 views
Seeking advice on system documentation
I have a rating engine (it is basically an algorithm) which when I started had no formal documentation. We have created a functional specification/decomposition which is our business level document ...
8
votes
3answers
135 views
How to document experimental or incomplete APIs like @deprecated?
Is there a good term that is similar but different than "deprecate" to mean that a method or API is in the code base but should not be used because its implementation is not complete or will likely ...
1
vote
1answer
134 views
How to document unlimited argument parameters?
In PHP you can have a function take an infinite number of arguments like
/**
* Do abc...
*
* @since 1.0
* @param mixed $arg1 Arg description
* @return string ...
2
votes
2answers
152 views
HTML in docblock comments?
In the PEAR standards there is no reference to HTML, if its allowed or not.
http://pear.php.net/manual/en/standards.sample.php
But I see some people use HTML tags like <kbd> and stuff..
So is ...
5
votes
4answers
398 views
How do you keep track of the meaning of your SQL fields?
The more SQL fields I add to my tables and the more primary/foreign keys I add the more I lose the overview for specific fields for certain scenarios like Get/Add/Delete/Update data.
I use SQL ...
8
votes
4answers
432 views
Where to put code documentation?
I am currently using two systems to write code documentation (am using C++):
Documentation about methods and class members are added next to the code, using the Doxygen format. On a server Doxygen ...
19
votes
4answers
781 views
Is BDD actually writable by non-programmers?
Behavior-Driven Development with its emblematic “Given-When-Then” scenarios syntax has lately been quite hyped for its possible uses as a boundary object for software functionality assessment.
I ...
5
votes
5answers
323 views
Where should a programmer explain the extended logic behind the code?
I have developed a few quantitative libraries in C# where it is important to understand not only the classic information that goes with the XMLDoc comments (which contains basic information with the ...
17
votes
5answers
577 views
How-to convince company to start documenting for legacy software
It has been less than a year since I joined my current company. Their majority of sales have come from a single product that has been alive since the last 10 years. However, there is minimal (if at ...
4
votes
3answers
130 views
What could be some pitfalls in introducing a style guide and documentation generating software in a development team?
I'm considering using appledoc, a flavor of Doxygen for use in generating Objective-C code documentation, in order to create documentation for my company's iOS apps. The idea is that a server will ...
5
votes
5answers
266 views
Whats sort of platform should I host documentation on?
We have a web-based software product that has a growing user-base of around 200+ people.
I won't go into details on our current workflow, but it involves word documents and converting to HTML and I ...
