“I”, “We”, or Neither in code documentation
I find myself writing (hopefully) helpful comments in code (C++) documentation of the type:
XML Documentation for IoC Classes
I’m working on an application that uses Inversion of Control to achieve loose coupling between the Data Access and Business Layers.
NoSQL and BIG DATA
I am doing an internship on Big Data technologies so I am new to this area. My question is about the use of NoSQL in the Big Data architecture. Do we need always to use a distributed storage (like HDFS in the case of Hadoop) then to put on top a NoSQL databases (like Hbase )?
Duplicating documentation on interface implementations/overrides good or bad?
So we have an interface like so
Diagrams used to model the architecture and functionality of a website
I am attempting to understand what UML models/diagrams can be used to communicate a websites architecture.
What is the best way to prove that in-code documentation is greater than extensive external documentation?
What is the best way to prove to my boss that in code documentation is greater than extensive external documents containing documentation and screenshots of code/ui?
What is the best way to understand code in a project with null documentation?
It is our first game and we are a start-up. We had a programmer who suddenly is seeming to be a dead weight. Though we knew him personally we thought that he was as motivated as we are and hence I never looked for a code review or documentation. Now it seems that he is slacking a lot and we want him out.
Preferrable Method to record Documentation
As any taught Software Engineer knows how important Documentation for good software projects is. Could you show me best practices for assure good documentation beside of JavaDoc comments?
Documenting Function That Takes Random Parameters?
What’s the best approach to creating documentation (displaying the function prototype if you will) for functions that take a variety of different forms in terms of parameters.
How do you keep track of what classes and functions your team has written?
When working on code, I face many of the same challenges that my teammates do, and I have written some helpful functions and classes, and so have they. If there is good communication, I’ll hear about some great thing someone put together, and six months later when I need it I may remember it and call that function, saving myself time. If I don’t remember it, or never knew about it, I will probably re-invent the wheel.