[Mono-dev] MonoTODO attribute usage policy.
Jackson Harper
jackson at ximian.com
Tue Nov 14 22:08:10 EST 2006
On Tue, 2006-11-14 at 16:34 -0500, Miguel de Icaza wrote:
> Hello,
>
> MonoTODO attributes have been used in the past for two purposes: to
> warn us about things that must be reviewed (this shows up on the class
> status pages) and for comments that a developer would use.
>
> Since the Mono Meeting, we discussed using MonoTODOs instead as a
> mechanism to provide a textual description that would assist a developer
> that might use the API. So the description should now be only to be
> consumed by a user of the API (this is what we actually had documented
> in the Wiki).
>
> This means that implementation notes like "We should improve X or
> Y", do not belong in MonoTODO attributes. Use "FIXME" strings on the
> code, or if the issue is one worth following up with, then file a bug in
> Bugzilla.
>
> I have updated the
>
> http://www.mono-project.com/Coding_Guidelines
There is also mention of this in mcs/class/README. Maybe we should just
nuke that file?
>
> page.
>
> Miguel.
> _______________________________________________
> Mono-devel-list mailing list
> Mono-devel-list at lists.ximian.com
> http://lists.ximian.com/mailman/listinfo/mono-devel-list
More information about the Mono-devel-list
mailing list