Changeset 9406 in orxonox.OLD for trunk/CODING-STANDARDS
- Timestamp:
- Jul 24, 2006, 11:09:47 AM (18 years ago)
- File:
-
- 1 edited
-
trunk/CODING-STANDARDS (modified) (10 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/CODING-STANDARDS
r3183 r9406 22 22 you are just bugfixing or extending write it under co-programmer. 23 23 24 c) Every element of the must be documented with doxygen-tags.24 c) Every element of the code must be documented with doxygen-tags (see 1.2). 25 25 26 26 1.2.Doxygen Tags: … … 29 29 most of the time they extend the /* or // with a second star or a ! 30 30 31 a) h-files: 31 a) h-files: 32 32 1) every h-file you want to be documented you have to tag. (tag looks like /*! \file somefile */ ) 33 33 2) every class has to be Documented. ( //! what it does) … … 38 38 39 39 c) look out for this: Doxygen parses preprocessor arguments, 40 so if some comments is excluded by a #ifdef, #endif 40 so if some comments is excluded by a #ifdef, #endif 41 41 doxygen will not parse it. And ther will be nothing in the docu. 42 42 … … 80 80 ----------- 81 81 /*! 82 \file someclass.h83 \brief Some short description of the someclass84 \todo maybe there remains something to do in this entire file85 86 Here comes a longer description87 this can also be longer than one line88 */82 * @file someclass.h 83 * @brief Some short description of the someclass 84 * @todo maybe there remains something to do in this entire file 85 * 86 * Here comes a longer description 87 * this can also be longer than one line 88 */ 89 89 90 90 #ifndef _SOMECLASS_H 91 91 #define _SOMECLASS_H 92 92 93 #include <many_headers>94 #include "stdincl.h"93 #include "project_headers" 94 #include <many_external_headers> 95 95 96 96 //! short description of the class 97 97 /** 98 \todo what remains to be done here99 100 101 */98 * @todo what remains to be done here 99 * 100 * longer description 101 */ 102 102 class SomeClass 103 103 { 104 p rivate:105 int usefull_variable;106 int cool_variable; //!< this variable is cool, because...104 public: /* functions */ 105 SomeClass(); 106 ~SomeClass(); 107 107 108 protected: 109 char* someOtherMember; 108 int mightyFunction(const std::string& name, int value); 110 109 111 public: 112 SomeClass (void); 113 ~SomeClass (void); 114 115 int mightyFunction (char* name, int value); 116 //.... 110 private: /* functions */ 111 void recompileInternalState(); 112 113 protected: /* variables */ 114 std::string someOtherMember; //!< some member, that can be touched by derived classes. 115 116 private: /* variables */ 117 int usefullVariable; //!< Usefull because 118 int coolVariable; //!< this variable is cool, because... 119 120 117 121 }; 118 122 … … 128 132 ------------ 129 133 130 /* 134 /* 131 135 orxonox - the future of 3D-vertical-scrollers 132 136 … … 139 143 140 144 ### File Specific: 141 main-programmer: The Name of Myself145 main-programmer: The Name of the author 142 146 co-programmer: ... 143 147 */ … … 147 151 148 152 /** 149 \brief <a brief description>150 \todo I think you get it.151 152 153 */153 * @brief <a brief description> 154 * @todo I think you get it. 155 * 156 * <more description> 157 */ 154 158 SomeClass::SomeClass (void) 155 159 { … … 158 162 159 163 /** 160 \brief <a brief description>161 \todo if something is not destructed it will be here162 163 164 * @brief <a brief description> 165 * @todo if something is not destructed it will be here 166 * 167 * <more description> 164 168 */ 165 169 ~SomeClass::~SomeClass (void) … … 169 173 170 174 /** 171 \brief <a brief description>172 \param name <what is this parameter for>173 \param valuse <what for...>174 \returns <what it returns>175 176 <more description>177 */178 int SomeClass::mightyFuncion (c har*name, int value)175 * @brief <a brief description> 176 * @param name <what is this parameter for> 177 * @param valuse <what for...> 178 * @returns <what it returns> 179 * 180 * <more description> 181 */ 182 int SomeClass::mightyFuncion (const std::string& name, int value) 179 183 { 180 184 this->coolVariable = value; … … 182 186 } 183 187 184 // ... 188 // ... i think you get it :)
Note: See TracChangeset
for help on using the changeset viewer.
