Activity for ForEachLoopâ€
Type | On... | Excerpt | Status | Date |
---|---|---|---|---|
Edit | Post #26403 | Initial revision | — | almost 5 years ago |
Edit | Post #26387 | Initial revision | — | almost 5 years ago |
Answer | — |
A: What are the benefits of including complete working code samples in documentation Working samples is an absolute must for all APIs. Period. Reference pages especially need one. Not including them overlooks the fact that API documentation is used by a range of people. It's short sighted by both the guys who says it and for the writing team to assume the documentation is only for th... (more) |
— | almost 7 years ago |
Answer | — |
A: Limitations of automatic documentation Automated systems such as Sandcastle and Swagger are good at converting code syntax into documentation. Those will produce marginal documentation. What they don't do is add insight into the calls. Rarely does a method exist by itself. There are always additional notes needed, caveats explained, side ... (more) |
— | almost 7 years ago |