Changes between Version 19 and Version 20 of StudentTips

Timestamp:

2012-09-12T14:52:37Z (12 years ago)

Author:

Jakub Jermář

Comment:

—

StudentTips

@@ -27 +27 @@
 
 === Implementation ===
-  * Do not impose artificial limits on your implementation. If your project is fundamentally platform-neutral, for example when what you implement is a sophisticated data structure or a new file system, do not restrict the implementation to a single supported processor architecture, byte order or word width.
+  * Do not impose artificial limits on your implementation. If your project is fundamentally platform-neutral, for example when what you implement is a sophisticated data structure or a new file system, do not restrict the implementation to a single supported processor architecture, byte order or word width. Remember that HelenOS is a portable multiplatform operating system. Your generic code is supposed to run everywhere where HelenOS can run. This ranges from small little-endian ARM devices to much bigger multiprocessor 64-bit big-endian UltraSPARC servers.
   * Stick to the [wiki:CStyle HelenOS coding style]. We really mean this. Your failure to adhere to the coding style of the surrounding code requires someone else's extra work to perform the cleanup after you. The fact that you may prefer another coding style is quite insignificant in the context of HelenOS. Get over it and use our coding style.
   * Adhere to good coding practices, such as adequate commenting, avoiding dense code, using horizontal spacing as visual delimiter and keeping the block nesting level under control. Also pay attention to seemingly subtle and unimportant decisions, such as proper naming of identifiers, following a coherent naming pattern, etc. Remember that the code is written once, but read many times. Do not make it harder for the reader than it is strictly necessary.