0
votes
2answers
264 views

How to write comments to explain the “why” behind the callback function when the function and parameter names are insufficient for that?

How should I approach writing comments for callback functions? I want to explain the "why" behind the function when the function and parameter names are insufficient to explain what's going on. I ...
8
votes
2answers
851 views

Documenting a programming language: Reference Manual

We are looking at revamping documentation across our product line. Part of that includes reference manuals for a programming language used as part of the system. When writing a reference manual for a ...
2
votes
1answer
152 views

Should I provide a language reference in addition to a formal specification for the programming language I am designing?

I am designing a programming language, and I would like to provide a complete documentation for it. So far, I have planned to write the following documents: An initial design outline, mostly as a ...
1
vote
2answers
185 views

How to use the APIs for different platforms?

From what I know, learning a programming language consists of : 1- Learning the syntax 2- Learning how does the language handle\use\implement its "abilities" (Classes, delegates, structs, ...
9
votes
4answers
702 views

How are undocumented functions discovered?

I've always wondered how do you find undocumented / private API ? Example the Apple undocumented / private API, Play Station, Windows Phone 7, Win32 Kernel, Windows API, hidden callback, etc... ...
11
votes
5answers
823 views

How do I go about writing a programming language specification?

I really enjoy programming language design. Sometimes I think my language projects and their potential users would benefit from a comprehensive standards document. I've looked at many language ...